feat: update docs (#47)

This commit is contained in:
vran
2022-03-13 22:15:23 +08:00
committed by GitHub
parent 6e798f4d97
commit 4b36dda6c2
35 changed files with 177 additions and 166 deletions

View File

@@ -0,0 +1,57 @@
# Docker 部署
[Databasir](https://github.com/vran-dev/databasir) 现在已经准备好了开箱即用的 Docker Image你只需要简单两步就可以完成一个 Databasir 应用的构建
## 环境要求
1. Docker
2. Mysql
## 部署流程
1. 拉取最新版镜像,当然你也可以将 latest 替换成你想要得版本号,具体有哪些镜像版本可以拉取可以在[这里](https://registry.hub.docker.com/r/vrantt/databasir)查看
```shell
docker pull vrantt/databasir:latest
```
2. 镜像下载完成以后就可以直接启动了
```shell
docker run --name my-databasir -e DATABASIR_DB_URL=127.0.0.1:3306 -e DATABASIR_DB_USERNAME=root -e DATABASIR_DB_PASSWORD=123456 databasir:latest -p 8888:8080
```
这里解释一下各个命令参数
- `--name` 代表镜像启动后的名称,你可以随意命名
- `-e` 指定环境变量databasir 需要依赖 3 个环境变量,所以用 `-e` 指定了 3 个变量,它们分别是
1. DATABASIR_DB_URL 数据库地址
2. DATABASIR_DB_USERNAME 数据库账号名称
3. DATABASIR_DB_PASSWORD 数据库密码
- `-p` 暴露端口databasir 默认在容器内部开放了 8080 端口,这里将宿主机的 8888 端口映射到了容器的 8080 端口
启动后Databasir 会默认创建一个超级管理员账户
- 用户名databasir
- 密码databasir
这时候访问 http://localhost:8888 进入登录页,输入上面的账号和密码即可成功登入。
## 登录验证
应用启动完成后会默认创建 Databasir 管理员用户
- 用户名databasir
- 密码databasir
通过该账号登录应用既可以进行管理

View File

@@ -0,0 +1,34 @@
# Jar 包部署
## 环境要求
1. Java 11+
2. Mysql
## 部署流程
1. 在 [Github RELEASE](https://github.com/vran-dev/databasir/releases) 页面下载最新版应用 Databasir.jar (你也可以选择克隆项目后自行构建)
2. 将 Databasir.jar 上传到服务器
3. 在 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
```
4. 通过 `java -jar Databasir.jar` 启动应用即可
## 登录验证
应用启动完成后会默认创建 Databasir 管理员用户
- 用户名databasir
- 密码databasir
通过该账号登录应用既可以进行管理