介绍MinDoc是一款针对IT团队开发的简单好用的文档管理系统。MinDoc的前身是SmartWiki文档系统。SmartWiki是基于PHP框架laravel开发的一款文档管理系统。因PHP的部署对普通用户来说太复杂,所以改用Golang开发。可以方便用户部署和实用。开发缘起是公司IT部门需要一款简单实用的项目接口文档管理和分享的系统。其功能和界面源于kancloud。可以用来储存日常接口文档,数据库字典,手册说明等文档。内置项目管理,用户管理,权限管理等功能,能够满足大部分中小团队的文档管理需求。

截图


功能

  • 项目管理,可以对项目进行编辑更改,成员添加等。
  • 文档管理,添加和删除文档等。
  • 评论管理,可以管理文档评论和自己发布的评论。
  • 用户管理,添加和禁用用户,个人资料更改等。
  • 用户权限管理 , 实现用户角色的变更。
  • 项目加密,可以设置项目公开状态,私有项目需要通过Token访问。
  • 站点配置,可开启匿名访问、验证码等。

安装

本教程只适用于CentOS 7,其它系统教程参考:Github地址

1、下载MinDoc并解压

访问这里下载最新版本并解压,以下命令供参考,请根据实际情况调整。

#创建一个目录
mkdir mindoc && cd mindoc
#下载二进制包
yum install -y wget
wget https://github.com/lifei6671/mindoc/releases/download/v0.9/mindoc_linux_amd64.zip
#解压
yum install -y unzip
unzip mindoc_linux_amd64.zip

2、配置数据库

MinDoc支持MysqlSqlite3数据库,一般需求不大的可以选Sqlite3,如果是团队使用可以考虑使用Mysql。修改conf/app.conf配置文件。如果你使用的 mysql 数据库,请创建一个编码为utf8mb4格式的数据库,如果没有GUI管理工具,推荐用下面的脚本创建:

CREATE DATABASE mindoc_db  DEFAULT CHARSET utf8mb4 COLLATE utf8mb4_general_ci;

如果你使用的是 sqlite 数据库,请将 conf/app.conf 中的数据库配置成如下,也就是取消Sqlite3的注释,并将以下Mysql信息注释。系统会自动创建 sqlite 数据库文件:

#将以下Mysql信息注释。
#db_adapter=mysql
#db_host=127.0.0.1
#db_port=3306
#db_database=mindoc_db
#db_username=root
#db_password=123456

db_adapter=sqlite3
db_database=mindoc_db

3、数据库初始化

请将刚才解压目录下 conf/app.conf.example 重名为 app.conf:

cp conf/app.conf.example conf/app.conf

同时配置如下节点:

#数据库配置
db_adapter=mysql
#mysql数据库的IP
db_host=127.0.0.1

#mysql数据库的端口号一般为3306
db_port=3306

#刚才创建的数据库的名称
db_database=mindoc_db

#访问数据库的账号和密码
db_username=root
db_password=123456

MinDoc 根目录下使用命令行执行如下命令,用于初始化数据库:

./mindoc_linux_amd64 install

稍等一分钟,程序会自动初始化数据库,并创建一个超级管理员账号:admin 密码:123456

4、运行与访问

执行如下命令启动程序:

#修改可执行权限
chmod +x mindoc_linux_amd64

#启动程序
./mindoc_linux_amd64

此时访问 http://localhost:8181 就能访问 MinDoc 了。

如果访问不了,注意防火墙/安全组等放行8181端口,Firewalld放行命令如下:

firewall-cmd --zone=public --add-port=8181/tcp --permanent
firewall-cmd --reload

5、配置代理

通过http://IP:8181这样的方式访问显然不太友好也不便于记忆,可以使用Nginx反向代理绑定域名访问 Nginx 代理的配置文件如下:

server {
    listen       80;

    #此处应该配置你的域名:
    server_name  webhook.iminho.me;

    charset utf-8;

    #此处配置你的访问日志,请手动创建该目录:
    access_log  /var/log/nginx/webhook.iminho.me/access.log;

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


【腾讯云】星星海SA2云服务器618钜惠,1核2G 首年95元【点击查看】。


文章: 《一款简单好用的文档管理系统:MinDoc安装教程》
联系方式:
文章链接:https://wxiou.cn/index.php/archives/65/
除特别注明外,文章均为Literature原创,转载时请注明本文出处及文章链接
Last modification:July 24th, 2020 at 06:11 pm
如果觉得我的文章对你有用,请随意赞赏