From d8394a7e6026fda8489d2c3315a6628d3dc0b2aa Mon Sep 17 00:00:00 2001 From: vran Date: Mon, 18 Apr 2022 16:15:55 +0800 Subject: [PATCH] feat:update docs --- docs/README/deploy/docker-deploy.md | 18 +++++++++--------- docs/README/deploy/jar-deploy.md | 4 ++++ 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/README/deploy/docker-deploy.md b/docs/README/deploy/docker-deploy.md index d2880e8..49a66cf 100644 --- a/docs/README/deploy/docker-deploy.md +++ b/docs/README/deploy/docker-deploy.md @@ -5,7 +5,7 @@ ## 环境要求 1. Docker -2. Mysql +2. Mysql 5.7+ ## 测活接口 @@ -38,13 +38,14 @@ docker run -p 8888:8080 --name my-databasir -e DATABASIR_DB_URL=127.0.0.1:3306 - **docker 启动命令参数说明** -| 参数 | 说明 | -| ---------------------------------- | ------------------------------------------------- | -| --name my-databasir | 启动的镜像名称 | -| -e DATABASIR_DB_URL=127.0.0.1:3306 | 数据库连接地址 | -| -e DATABASIR_DB_USERNAME=root | 数据库连接用户名 | -| -e DATABASIR_DB_PASSWORD=123456 | 数据库连接密码 | -| -p 8888:8080 | 将 databasir 的 8080 端口映射到宿主机的 8888 端口 | +| 参数 | 说明 | 必填 | +| ---------------------------------- | ------------------------------------------------------------ | ---- | +| --name my-databasir | 启动的镜像名称 | | +| -e DATABASIR_DB_URL=127.0.0.1:3306 | 数据库连接地址 | 是 | +| -e DATABASIR_DB_USERNAME=root | 数据库连接用户名 | 是 | +| -e DATABASIR_DB_PASSWORD=123456 | 数据库连接密码 | 是 | +| -e DATABASIR_JWT_SECRET=databasir | 生成用户登录 Token 的秘钥，如果部署了多个实例，那多个实例之间的秘钥要保持一致。默认为 UUID | 否 | +| -p 8888:8080 | 将 databasir 的 8080 端口映射到宿主机的 8888 端口 | | ## 登录验证 @@ -54,4 +55,3 @@ docker run -p 8888:8080 --name my-databasir -e DATABASIR_DB_URL=127.0.0.1:3306 - - 密码：`databasir` 这时候访问 http://localhost:8888 进入登录页，输入上面的账号和密码即可成功登入，到此就算部署完成 - diff --git a/docs/README/deploy/jar-deploy.md b/docs/README/deploy/jar-deploy.md index 7b99eff..88e3b72 100644 --- a/docs/README/deploy/jar-deploy.md +++ b/docs/README/deploy/jar-deploy.md @@ -20,10 +20,14 @@ databasir.db.username=root databasir.db.password=123456 # 数据库地址 databasir.db.url=127.0.0.1:3306 +# 登录 token 生成秘钥，可选 +databasir.jwt.secret=${random.uuid} ``` 4. 通过 `java -jar Databasir.jar` 启动应用即可 +**注意：**如果部署了多个 databasir 实例，一定要定义 `databasir.jwt.secret` 的值，从而使得多个实例之间的 `databasir.jwt.secret` 保持一致 + ## 登录验证 应用启动完成后会默认创建 Databasir 管理员用户