一、开源项目简介
Databasir 是面向团队的关系型数据库模型文档管理平台，旨在通过自动化的方式解决模型文档管理过程中维护成本高、内容更新不及时以及团队协作复杂等问题。
二、开源协议
使用Apache-2.0开源协议
三、界面展示
四、功能概述
Databasir 是一款专注于数据库文档管理的开源平台，提供了自动化、版本化、团队化、个性化的文档管理特性。
- 自动化：表结构逆向生成文档，支持手动、定时同步，文档变更自动通知等
- 版本化：文档多版本记录，一键查看版本差异
- 团队化：扁平化的角色管理、系统日志审计、团队协作
- 个性化：文档模板自定义、理论支持任意拥有 JDBC 驱动的数据库、支持 Markdown、UML 导出
特性
- 兼容市面多数数据库：支持所有拥有 JDBC 驱动的数据库，mysql、postgresql 开箱即用
- 丰富的文档管理功能：支持文档自动同步，版本历史回溯，版本差异对比，文档讨论，UML 生成， 文档导出，数据 SQL 生成等，应有尽有
- 面向团队的协作能力：扁平化的角色管理，支持 Github Github Enterprise Gitlab 的 OAuth2 登录，日志审计
五、技术选型
Jar 包部署
环境要求
- Java 11+
- Mysql 5.7+
部署流程
- 在 一飞开源：https://code.exmay.com/ 下载最新版应用 生成 Databasir.jar
- 将 Databasir.jar 上传到服务器
- 在 Databasir.jar 所在目录创建 config 目录，并在目录下创建 application.properties 配置，配置中配置 MYSQL 的用户名、密码和连接
# 端口号，默认 8080server.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 启动应用即可
注意：如果部署了多个 databasir 实例，一定要定义 databasir.jwt.secret 的值，从而使得多个实例之间的 databasir.jwt.secret 保持一致
登录验证
应用启动完成后会默认创建 Databasir 管理员用户
- 用户名：databasir
- 密码：databasir
通过该账号登录应用既可以进行管理
Docker 部署
Databasir 已经准备好了开箱即用的 Docker Image，你只需要简单三步就可以完成一个 Databasir 应用的部署
环境要求
- Docker
- Mysql 5.7+
测活接口
GET /live 返回 200 即表示启动成功
部署流程
- 拉取最新版镜像，当然你也可以将 latest 替换成你想要得版本号，具体有哪些镜像版本可以拉取可以在这里查看
docker pull vrantt/databasir:latest - 在 Mysql 中创建数据库 databasir
create database databasir; - 启动镜像，需要指定可用的 Mysql 的连接信息
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 进入登录页，输入上面的账号和密码即可成功登入，到此就算部署完成
关注公众号，发送如下消息获取下载链接：
"源代码下载:C1250"