MinDoc文档管理系统

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

安装与使用

如果你还没有安装Golang，需要手动设置一个环境变量ZONEINFO，值为MinDoc根目录下的/lib/time/zoneinfo.zip。对于有Golang开发经验的开发者，建议通过编译安装，要求Golang版本不小于1.15.1，支持CGO、go mod和import "_ "time/tzdata"。

常规编译

1、克隆源码：

git clone https://github.com/mindoc-org/mindoc.git

2、安装go包：

go mod tidy -v

3、编译（SQLite需要CGO支持）：

go build -ldflags " -w " -o mindoc main.go

4、数据库初始化（需配置conf/app.conf）：

./mindoc install

5、运行：

./mindoc

Linux系统中不依赖gLibC的编译方式

1、安装musl-gcc：

wget -c http://musl.libc.org/releases/musl-1.2.2.tar.gz
tar -xvf musl-1.2.2.tar.gz
cd musl-1.2.2
./configure
make
sudo make install

2、编译mindoc：

go mod tidy -v
export GOARCH=amd64
export GOOS=linux
export CC=/usr/local/musl/bin/musl-gcc
go build -v -o mindoc_linux_musl_amd64 -ldflags= " -linkmode external -extldflags '-static' -w -X 'github.com/mindoc-org/mindoc/conf.VERSION= $TRAVIS_TAG ' -X 'github.com/mindoc-org/mindoc/conf.BUILD_TIME= ` date ` ' -X 'github.com/mindoc-org/mindoc/conf.GO_VERSION= ` go version ` ' "

使用Docker部署

对于Docker用户，可以参考项目内置的Dockerfile文件自行编译镜像。在启动镜像时，需要提供一些常用的环境变量，例如DB_ADAPTER、MYSQL_PORT_3306_TCP_ADDR、MYSQL_PORT_3306_TCP_PORT等。

示例

Windows：

set MINDOC=//d/mindoc
docker run -it --name=mindoc --restart=always -v "%MINDOC%/conf" : "/mindoc/conf" -p 8181:8181 -e MINDOC_ENABLE_EXPORT=true -d registry.cn-hangzhou.aliyuncs.com/mindoc-org/mindoc:v2.1

Linux/Mac：

export MINDOC=/home/ubuntu/mindoc
docker run -it --name=mindoc --restart=always -v "${MINDOC}/conf" : "/mindoc/conf" -p 8181:8181 -e MINDOC_ENABLE_EXPORT=true -d registry.cn-hangzhou.aliyuncs.com/mindoc-org/mindoc:v2.1

功能

MinDoc提供了多种功能，包括项目管理、文档管理、评论管理、用户管理和权限管理等，支持项目加密，可以设置项目为公开或私有，私有项目需要通过Token访问。MinDoc支持站点配置，可以开启匿名访问和验证码等。