feat: redesign doc pages (#153)

This commit is contained in:
vran
2022-05-07 22:35:27 +08:00
committed by GitHub
parent 6b328735af
commit f2c4de5bb1
120 changed files with 260 additions and 55 deletions

View File

@@ -0,0 +1,57 @@
# Docker 部署
[Databasir](https://github.com/vran-dev/databasir) 已经准备好了开箱即用的 Docker Image你只需要简单三步就可以完成一个 Databasir 应用的部署
## 环境要求
1. Docker
2. Mysql 5.7+
## 测活接口
```shell
GET /live
```
返回 200 即表示启动成功
## 部署流程
1. 拉取镜像(更多版本[点击这里](https://registry.hub.docker.com/r/vrantt/databasir)查看)
```shell
docker pull vrantt/databasir:latest
```
2. 在 Mysql 中创建数据库 databasir
```sql
create database databasir;
```
3. 启动镜像,需要指定可用的 Mysql 的连接信息
```shell
docker run -p 8888:8080 --name my-databasir -e DATABASIR_DB_URL=127.0.0.1:3306 -e DATABASIR_DB_USERNAME=root -e DATABASIR_DB_PASSWORD=123456 vrantt/databasir:latest
```
**docker 启动命令参数说明**
| 参数 | 说明 | 必填 |
| ---------------------------------- | ------------------------------------------------------------ | ---- |
| --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 端口 | |
## 登录验证
启动后Databasir 会默认创建一个超级管理员账户
- 用户名:`databasir`
- 密码:`databasir`
这时候访问 http://localhost:8888 进入登录页,输入上面的账号和密码即可成功登入,到此就算部署完成

View File

@@ -0,0 +1,74 @@
# Jar 包部署
## 环境要求
1. Java 11+
2. Mysql 5.7+
## 部署流程
1. 在 [Github RELEASE](https://github.com/vran-dev/databasir/releases) 页面下载最新版应用 Databasir.jar (你也可以选择克隆项目后自行构建)
2. 将 Databasir.jar 上传到服务器
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
server.port=8080
# 数据库用户名
databasir.db.username=root
# 数据库密码
databasir.db.password=123456
# 数据库地址
databasir.db.url=127.0.0.1:3306
# 登录 token 生成秘钥,可选
databasir.jwt.secret=${random.uuid}
```
通过 `java -jar Databasir.jar` 启动应用即可