简介

MinDoc 的前身是 SmartWiki 文档系统。SmartWiki 是基于 PHP 框架 laravel 开发的一款文档管理系统。因 PHP 的部署对普通用户来说太复杂，所以改用 Golang 开发。可以方便用户部署和实用。可以用来储存日常接口文档，数据库字典，手册说明等文档。内置项目管理，用户管理，权限管理等功能，能够满足大部分中小团队的文档管理需求。

开源地址：https://github.com/lifei6671/mindoc

演示站点：http://doc.iminho.me

主要功能

• 项目管理，可以对项目进行编辑更改，成员添加等。
• 文档管理，添加和删除文档，文档历史恢复等。
• 用户管理，添加和禁用用户，个人资料更改等。
• 用户权限管理 ， 实现用户角色的变更。
• 项目加密，可以设置项目公开状态，私有项目需要通过Token访问。
• 站点配置，二次开发时可以添加自定义配置项。
• 附件管理，可管理所有项目中上传的文件。
• 项目导出，目前支持导出 PDF、Word、EPUB、MOBI、Markdown 等格式项目。
• 标签管理，可关系已存在的项目标签
• 导入项目，支持导入Markdown压缩包成为一个项目
• 二级目录部署，支持将 MinDoc 部署到二级子目录

使用Docker部署

安装docker环境

该脚本适用于Ubuntu、Centos、Debian、树莓派等系统

 echo y | bash <(curl -L -s https://raw.githubusercontent.com/Baiyuetribe/codes/master/docker.sh)

部署程序

在启动镜像时需要提供如下的环境变量：

 DB_ADAPTER                  指定 DB
 MYSQL_PORT_3306_TCP_ADDR    MySQL地址
 MYSQL_PORT_3306_TCP_PORT    MySQL端口号
 MYSQL_INSTANCE_NAME         MySQL数据库名称
 MYSQL_USERNAME              MySQL账号
 MYSQL_PASSWORD              MySQL密码
 HTTP_PORT                   程序监听的端口号

docker run -p 8181:8181 --name mindoc -e DB_ADAPTER=mysql -e MYSQL_PORT_3306_TCP_ADDR=192.168.10.3 -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一键部署

获取YMAL

mkdir -p /docker/minidoc && cd /docker/minidoc
wget https://raw.githubusercontent.com/lifei6671/mindoc/master/docker-compose.yml

修改docker-compose.yml中的配置信息

• volumes节点，将宿主机的两个目录映射到容器内;
• environment节点，配置自己的环境变量。

部署

docker-compose up -d

然后访问http://ip:8181即可进入，超级管理员用户：admin 密码：123456

常用docker-compose命令参考

• 启动

  docker-compose up -d

• 停止

  docker-compose stop

• 重启

  docker-compose restart

• 停止删除容器，释放所有资源

  docker-compose down

• 删除并重新创建

  docker-compose -f docker-compose.yml down && docker-compose up -d