服务简介
MinDoc 是一款针对 IT 团队开发的简单好用的文档管理系统。
MinDoc 的前身是 SmartWiki 文档系统。SmartWiki 是基于 PHP 框架 laravel 开发的一款文档管理系统。因
PHP 的部署对普通用户来说太复杂,所以改用 Golang 开发。可以方便用户部署和实用,同时增加 Markdown 和 HTML
两种编辑器。开发缘起是公司 IT 部门需要一款简单实用的项目接口文档管理和分享的系统。其功能和界面源于 kancloud 。
可以用来储存日常接口文档,数据库字典,手册说明等文档。内置项目管理,用户管理,权限管理等功能,能够满足大部分中小团队的文档管理需求。
- 主要功能
项目管理,可以对项目进行编辑更改,成员添加等。
文档管理,添加和删除文档等。
评论管理,可以管理文档评论和自己发布的评论。
用户管理,添加和禁用用户,个人资料更改等。
用户权限管理 , 实现用户角色的变更。
项目加密,可以设置项目公开状态,私有项目需要通过 Token 访问。
站点配置,可开启匿名访问、验证码等。
服务部署
docker-compose部署
- 编写YML文件
vim docker-compose-mindoc.yml
version: '3.2'
services:
mindoc:
image: registry.cn-hangzhou.aliyuncs.com/mindoc/mindoc:v2.0-beta.2
container_name: mindoc
user: root
privileged: true
restart: always
ports:
- 8181:8181
volumes:
- ./mindoc/database:/mindoc/database
- ./mindoc/uploads:/mindoc/uploads
- ./mindoc/mindoc.jpg:/mindoc/static/images/headimgurl.jpg
#- ./mindoc/views:/mindoc/views #需先复制出目录后映射进容器
environment:
- MINDOC_BASE_URL=http://182.92.109.195:8181
- MINDOC_RUN_MODE=prod
- MINDOC_DB_ADAPTER=mysql
- MINDOC_DB_HOST=172.17.34.124
- MINDOC_DB_PORT=3306
- MINDOC_DB_DATABASE=mindoc_db
- MINDOC_DB_USERNAME=root
- MINDOC_DB_PASSWORD=123456
- MINDOC_CACHE=true
- MINDOC_CACHE_PROVIDER=file
- MINDOC_ENABLE_EXPORT=true
mysql:
image: docker.io/mysql:5.7.30 #使用镜像
container_name: mysql #容器名称
restart: always #是否自启动
volumes:
- ./mysql/data:/var/lib/mysql #映射数据目录
- ./mysql/etc/my.cnf:/etc/mysql/my.cnf #映射配置文件
- ./mysql/logs:/var/log/mysql #映射日志文件
environment:
TZ: Asia/Shanghai
MYSQL_ROOT_PASSWORD: 123456 #设置root密码
ports:
- 3306:3306 #映射端口
- 创建部署目录及配置文件
mkdir mysql/{data,etc,logs}
mkdir mindoc/{database,uploads}
cat > mysql/etc/my.cnf << EOF
[mysqld]
#最大连接数
max_connections = 1500
log-error=/var/log/mysql/mysql.err
#半同步设置(根据需求开启)
#rpl_semi_sync_master_enabled = 1
#rpl_semi_sync_master_timeout = 10000
#rpl_semi_sync_slave_enabled = 1
#设置默认字符集
character-set-server=utf8mb4
#server——id
server-id=1
#二进制日志
log-bin=/var/log/mysql/binlog/mysql-bin
#binlog_format = mixed
expire_logs_days = 1
#中继日志
relay-log=relay-bin
relay_log_purge=0
read_only=1
relay-log-index=slave1-relay-bin.index
#慢日志
slow_query_log = 1
slow_query_log_file = /var/log/mysql/mysql_slow.log
long_query_time = 1
[mysql]
#设置mysql客户端默认字符集
default-character-set=utf8mb4
EOF
- 启动
docker-compose -f docker-compose-mindoc.yml up -d
- 访问 http://ip:8181 ( admin / 123456 )