简介
MinDoc 是一款针对IT团队开发的简单好用的文档管理系统。
MinDoc 的前身是 SmartWiki 文档系统。SmartWiki 是基于 PHP 框架 laravel 开发的一款文档管理系统。因 PHP 的部署对普通用户来说太复杂,所以改用 Golang 开发。可以方便用户部署和实用。
开发缘起是公司IT部门需要一款简单实用的项目接口文档管理和分享的系统。其功能和界面源于 kancloud 。
可以用来储存日常接口文档,数据库字典,手册说明等文档。内置项目管理,用户管理,权限管理等功能,能够满足大部分中小团队的文档管理需求。
Windows 安装教程
如果你的服务器上没有安装golang程序请手动设置一个环境变量如下:键名为 ZONEINFO,值为MinDoc跟目录下的/lib/time/zoneinfo.zip 绝对路径。
如果下载的压缩包中不存在该文件,请从 下载
第一步 下载可执行文件
请从 下载最新版的可执行文件,一般文件名为 godoc_windows_amd.zip .
第二步 解压压缩包
请将刚才下载的文件解压,推荐使用好压解压到任意目录。建议不用用中文明明目录名称。
第三步 创建数据库
如果你使用的 mysql 数据库,请创建一个编码为utf8mb4格式的数据库,如果没有GUI管理工具,推荐用下面的脚本创建:
CREATE DATABASE mindoc_db DEFAULT CHARSET utf8mb4 COLLATE utf8mb4_general_ci;
如果你使用的是 sqlite 数据库,请将 conf/app.conf 中的数据库配置成如下,系统会自动创建 sqlite 数据库文件:
db_adapter=sqlite3db_database=mindoc_db
第四步 配置数据库
请将刚才解压目录下 conf/app.conf.example 重名为 app.conf。同时配置如下节点:
#数据库配置db_adapter=mysql#mysql数据库的IPdb_host=127.0.0.1 #mysql数据库的端口号一般为3306db_port=3306#刚才创建的数据库的名称db_database=mindoc_db#访问数据库的账号和密码db_username=rootdb_password=123456
在 MinDoc 根目录下使用命令行执行如下命令,用于初始化数据库:
godoc_windows_amd64.exe install
第五步 启动程序
如果你设置了环境变量,但是没有重启电脑,请在cmd命令行启动 godoc_windows_amd64.exe 程序。
如果你设置了环境变量,并且重启了电脑,双击 godoc_windows_amd64.exe 即可。
稍等一分钟,程序会自动初始化数据库,并创建一个超级管理员账号:admin 密码:123456
此时访问 就能访问 MinDoc 了。
第六步 配置代理
这一步可选,如果你不想用端口号访问 MinDoc 就需要配置一个代理了。
推荐使用nginx做前端代理,当然,也可以用IIS做代理。
IIS的代理教程请参见 :
Nginx 代理的配置文件如下:
server { listen 80; #此处应该配置你的域名: server_name webhook.iminho.me; charset utf-8; #此处配置你的访问日志,请手动创建该目录: access_log /var/log/nginx/webhook.iminho.me/access.log; location ~ .*\.(ttf|woff2|eot|otf|map|swf|svg|gif|jpg|jpeg|bmp|png|ico|txt|js|css)$ { #此处将路径执行 MinDoc 的跟目录 root "/var/go/godoc"; expires 30m; } location / { try_files /_not_exists_ @backend; } # 这里为具体的服务代理配置 location @backend { proxy_set_header X-Forwarded-For $remote_addr; proxy_set_header Host $http_host; proxy_set_header X-Forwarded-Proto $scheme; #此处配置 MinDoc 程序的地址和端口号 proxy_pass http://127.0.0.1:8181; }}