diff --git a/docs/README/deploy/jar-deploy.md b/docs/README/deploy/jar-deploy.md index 8cc0f31..8db86de 100644 --- a/docs/README/deploy/jar-deploy.md +++ b/docs/README/deploy/jar-deploy.md @@ -5,11 +5,51 @@ 1. Java 11+ 2. Mysql 5.7+ + + ## 部署流程 1. 在 [Github RELEASE](https://github.com/vran-dev/databasir/releases) 页面下载最新版应用 Databasir.jar (你也可以选择克隆项目后自行构建) 2. 将 Databasir.jar 上传到服务器 -3. 在 Databasir.jar 所在目录创建 config 目录,并在目录下创建 `application.properties` 配置,配置中配置 MYSQL 的用户名、密码和连接 + +3. 执行启动命令 + +```java +java -jar databasir.jar --databasir.db.url=127.0.0.1:3306 --databasir.db.username=root --databasir.db.password=123456 +``` + + + +目前支持以下参数 + +| 参数名 | 说明 | 是否必传 | 默认值 | +| ----------------------------- | --------------------- | -------- | ------------------------------ | +| databasir.db.url | 数据库地址 | 是 | | +| databasir.db.username | 数据库用户名 | 是 | | +| databasir.db.password | 数据库密码 | 是 | | +| databasir.jwt.secret | 生成登录 Token 的秘钥 | 否 | uuid | +| databasir.db.driver-directory | 自定义驱动的上传目录 | 否 | 项目所在位置的 `drivers/` 目录 | + +**注意:**如果部署了多个 databasir 实例,一定要定义 `databasir.jwt.secret` 的值,从而使得多个实例之间的 `databasir.jwt.secret` 保持一致 + + + +## 登录验证 + +应用启动完成后会默认创建 Databasir 管理员用户 + +- 用户名:databasir +- 密码:databasir + +通过该账号登录应用既可以进行管理 + + + +## 通过配置文件指定参数 + +除了在命令行指定参数启动外,还可以通过配置文件来保存 + +在 Databasir.jar 所在目录创建 config 目录,并在目录下创建 `application.properties` 配置,配置中配置 MYSQL 的用户名、密码和连接 ```properties # 端口号,默认 8080 @@ -24,15 +64,11 @@ databasir.db.url=127.0.0.1:3306 databasir.jwt.secret=${random.uuid} ``` -4. 通过 `java -jar Databasir.jar` 启动应用即可 +通过 `java -jar Databasir.jar` 启动应用即可 + + -**注意:**如果部署了多个 databasir 实例,一定要定义 `databasir.jwt.secret` 的值,从而使得多个实例之间的 `databasir.jwt.secret` 保持一致 -## 登录验证 -应用启动完成后会默认创建 Databasir 管理员用户 -- 用户名:databasir -- 密码:databasir -通过该账号登录应用既可以进行管理 \ No newline at end of file