MinDoc 简介

MinDoc 简介
安装与使用
使用 Docker 部署
项目截图
使用的技术
主要功能
参与开发
关于作者

MinDoc 是一款针对 IT 团队开发的简单好用的文档管理系统。

MinDoc 的前身是 SmartWiki 文档系统。SmartWiki 是基于 PHP 框架 laravel 开发的一款文档管理系统。因 PHP 的部署对普通用户来说太复杂，所以改用 Golang 开发。可以方便用户部署和实用。

开发缘起是公司 IT 部门需要一款简单实用的项目接口文档管理和分享的系统。其功能和界面源于 kancloud 。

可以用来储存日常接口文档，数据库字典，手册说明等文档。内置项目管理，用户管理，权限管理等功能，能够满足大部分中小团队的文档管理需求。

演示站点：https://ctrlasd.com/

安装与使用

如果你的服务器上没有安装 golang 程序请手动设置一个环境变量如下：键名为 ZONEINFO，值为 MinDoc 跟目录下的 /lib/time/zoneinfo.zip 。

Windows 教程: /docs/mindoc/mindoc-windows

Linux 教程: /docs/mindoc/mindoc-linux

MinDoc 功能配置教程: /docs/mindoc/config

对于没有 Golang 使用经验的用户，可以从 https://github.com/lifei6671/mindoc/releases 这里下载编译完的程序。

如果有 Golang 开发经验，建议通过编译安装。

git clone https://github.com/lifei6671/mindoc.git
go get -d ./...
go build -ldflags "-w"

MinDoc 使用 MySQL 储存数据，且编码必须是 utf8mb4_general_ci。请在安装前，把数据库配置填充到项目目录下的 conf/app.conf 中。

如果 conf 目录下不存在 app.conf 请重命名 app.conf.example 为 app.conf。

如果 MinDoc 根目录下存在 install.lock 文件表示已经初始化过数据库，想要重新初始化数据库，只需要删除该文件重新启动程序即可。

默认程序会自动创建表，同时初始化一个超级管理员用户：admin 密码：123456 。请登录后重新设置密码。

Linux 下后台运行

在 Linux 如果想让程序后台运行可以执行如下命令：

#使程序后台运行
nohup ./godoc &amp;

该命令会使程序后台执行，但是服务器重启后不会自动启动服务。

使用 supervisor 做服务，可以使服务器重启后自动重启 MinDoc。

Windows 下后台运行

Windows 下后台运行需要借助 CMD 命令行命令：

#在 MinDoc 跟目录下新建一个 slave.vbs 文件：
Set ws = CreateObject("Wscript.Shell")
ws.run "cmd /c start.bat",vbhide
#再建一个 start.bat 文件：
@echo off
godoc_windows_amd64.exe

启动时双击 slave.vbs 即可，等待程序初始化完数据库会在该目录下创建一个 install.lock 文件，标识已安装成功。

如果是自己编译，可以用以下命令即可编译出不依赖 cmd 命令的后台运行的程序：

go build -ldflags "-H=windowsgui"

通过该命令编译的 Golang 程序在 Windows 上默认后台运行。

请将将 MinDoc 加入开机启动列表，使程序开机启动。

密码找回功能

密码找回功能依赖邮件服务，因此，需要配置邮件服务才能使用该功能,该配置位于 conf/app.conf 中：

#邮件配置
#是否启用邮件
enable_mail=true
#smtp服务器的账号
smtp_user_name=admin@iminho.me
#smtp服务器的地址
smtp_host=smtp.ym.163.com
#密码
smtp_password=1q2w3e__ABC
#端口号
smtp_port=25
#邮件发送人的地址
form_user_name=admin@iminho.me
#邮件有效期30分钟
mail_expired=30

使用 Docker 部署

如果是 Docker 用户，可参考项目内置的 Dockerfile 文件编译镜像。

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

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 -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