Merge pull request #304 from ehlxr/master

更新 Dockerfile 适配使用 MySQL 数据源
This commit is contained in:
Minho 2018-06-27 17:22:03 +08:00 committed by GitHub
commit 01084c7b0b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 9 deletions

View File

@ -19,6 +19,7 @@ FROM alpine:latest
LABEL maintainer="ehlxr.me@gmail.com" LABEL maintainer="ehlxr.me@gmail.com"
WORKDIR /mindoc WORKDIR /mindoc
COPY --from=0 /go/src/github.com/lifei6671/mindoc . COPY --from=0 /go/src/github.com/lifei6671/mindoc .
ENV ZONEINFO=/mindoc/lib/time/zoneinfo.zip
RUN chmod +x start.sh RUN chmod +x start.sh
CMD ["./start.sh"] CMD ["./start.sh"]

View File

@ -3,11 +3,11 @@
[![Build Status](https://travis-ci.org/lifei6671/mindoc.svg?branch=master)](https://travis-ci.org/lifei6671/mindoc) [![Build Status](https://travis-ci.org/lifei6671/mindoc.svg?branch=master)](https://travis-ci.org/lifei6671/mindoc)
[![Build status](https://ci.appveyor.com/api/projects/status/ik70whjrioyvfy18/branch/master?svg=true)](https://ci.appveyor.com/project/lifei6671/godoc/branch/master) [![Build status](https://ci.appveyor.com/api/projects/status/ik70whjrioyvfy18/branch/master?svg=true)](https://ci.appveyor.com/project/lifei6671/godoc/branch/master)
MinDoc 是一款针对IT团队开发的简单好用的文档管理系统。 MinDoc 是一款针对IT团队开发的简单好用的文档管理系统。
MinDoc 的前身是 SmartWiki 文档系统。SmartWiki 是基于 PHP 框架 laravel 开发的一款文档管理系统。因 PHP 的部署对普通用户来说太复杂,所以改用 Golang 开发。可以方便用户部署和实用。 MinDoc 的前身是 SmartWiki 文档系统。SmartWiki 是基于 PHP 框架 laravel 开发的一款文档管理系统。因 PHP 的部署对普通用户来说太复杂,所以改用 Golang 开发。可以方便用户部署和实用。
开发缘起是公司IT部门需要一款简单实用的项目接口文档管理和分享的系统。其功能和界面源于 kancloud 。 开发缘起是公司IT部门需要一款简单实用的项目接口文档管理和分享的系统。其功能和界面源于 kancloud 。
可以用来储存日常接口文档,数据库字典,手册说明等文档。内置项目管理,用户管理,权限管理等功能,能够满足大部分中小团队的文档管理需求。 可以用来储存日常接口文档,数据库字典,手册说明等文档。内置项目管理,用户管理,权限管理等功能,能够满足大部分中小团队的文档管理需求。
@ -39,7 +39,7 @@ go build -ldflags "-w"
MinDoc 使用MySQL储存数据且编码必须是`utf8mb4_general_ci`。请在安装前,把数据库配置填充到项目目录下的 conf/app.conf 中。 MinDoc 使用MySQL储存数据且编码必须是`utf8mb4_general_ci`。请在安装前,把数据库配置填充到项目目录下的 conf/app.conf 中。
如果conf目录下不存在 app.conf 请重命名 app.conf.example 为 app.conf。 如果conf目录下不存在 app.conf 请重命名 app.conf.example 为 app.conf。
**默认程序会自动初始化一个超级管理员用户admin 密码123456 。请登录后重新设置密码。** **默认程序会自动初始化一个超级管理员用户admin 密码123456 。请登录后重新设置密码。**
## Linux 下后台运行 ## Linux 下后台运行
@ -62,8 +62,8 @@ Windows 下后台运行需要借助 CMD 命令行命令:
```bash ```bash
#在MinDoc跟目录下新建一个slave.vbs文件 #在MinDoc跟目录下新建一个slave.vbs文件
Set ws = CreateObject("Wscript.Shell") Set ws = CreateObject("Wscript.Shell")
ws.run "cmd /c start.bat",vbhide ws.run "cmd /c start.bat",vbhide
#再建一个start.bat文件 #再建一个start.bat文件
@echo off @echo off
@ -113,6 +113,7 @@ mail_expired=30
在启动镜像时需要提供如下的环境变量: 在启动镜像时需要提供如下的环境变量:
```ini ```ini
DB_ADAPTER 制定 DB
MYSQL_PORT_3306_TCP_ADDR MySQL地址 MYSQL_PORT_3306_TCP_ADDR MySQL地址
MYSQL_PORT_3306_TCP_PORT MySQL端口号 MYSQL_PORT_3306_TCP_PORT MySQL端口号
MYSQL_INSTANCE_NAME MySQL数据库名称 MYSQL_INSTANCE_NAME MySQL数据库名称
@ -124,7 +125,7 @@ HTTP_PORT 程序监听的端口号
举个栗子 举个栗子
```bash ```bash
docker run -p 8181:8181 -e MYSQL_PORT_3306_TCP_ADDR=127.0.0.1 -e MYSQL_PORT_3306_TCP_PORT=3306 -e MYSQL_INSTANCE_NAME=mindoc_db -e MYSQL_USERNAME=root -e MYSQL_PASSWORD=123456 -e httpport=8181 -d daocloud.io/lifei6671/mindoc:latest docker run -p 8181:8181 --name mindoc -e DB_ADAPTER=mysql -e MYSQL_PORT_3306_TCP_ADDR=10.xxx.xxx.xxx -e MYSQL_PORT_3306_TCP_PORT=3306 -e MYSQL_INSTANCE_NAME=mindoc -e MYSQL_USERNAME=root -e MYSQL_PASSWORD=123456 -e httpport=8181 -d daocloud.io/lifei6671/mindoc:latest
``` ```
### docker-compose 一键安装 ### docker-compose 一键安装
1. 生成配置文件 1. 生成配置文件
@ -135,7 +136,7 @@ docker run -p 8181:8181 -e MYSQL_PORT_3306_TCP_ADDR=127.0.0.1 -e MYSQL_PORT_3306
> docker-compose up -d mindoc > docker-compose up -d mindoc
3. 浏览器访问 3. 浏览器访问
> http://localhost:8181/ > http://localhost:8181/
整个部署完成了 整个部署完成了
4. 常用命令参考 4. 常用命令参考
- 启动 - 启动
@ -143,10 +144,10 @@ docker run -p 8181:8181 -e MYSQL_PORT_3306_TCP_ADDR=127.0.0.1 -e MYSQL_PORT_3306
- 停止 - 停止
> docker-compose stop mindoc > docker-compose stop mindoc
- 重启 - 重启
> docker-compose restart mindoc > docker-compose restart mindoc
- 停止删除容器,释放所有资源 - 停止删除容器,释放所有资源
> docker-compose down > docker-compose down
更多 docker-compose 的使用相关的内容 请查看官网文档或百度 更多 docker-compose 的使用相关的内容 请查看官网文档或百度
# 项目截图 # 项目截图