MinDoc团队文档服务搭建指南

DarinLo 2016/10/20 软件教程软件环境团队协作团队文档

由于团队的文档是放在Quip上，都由于墙的缘故，经常上不了，造成其他团队成员无法看到。于是自己搭建一个团队文档系统，使用的是MinDoc开源团队文档系统 (opens new window)，也可以方便地保存数据，同时可以放更多的团队相关的文档在上面，编写文档的方式可以是HTML和Markdown，即使不用这个系统迁移成本也不大。

# 一、系统需要环境

Go语言环境：Golang
数据库环境：Mysql

# 二、安装步骤

# 1. 安装Golang环境

Ubuntu、Debian或Linux Mint安装Go语言：基于 Debian的 Linux 发行版本都可以使用 apt-get 命令来进行安装：

sudo apt-get install golang

要查看当前系统安装的 Go 语言版本可以使用如下命令：

go version

Fedora、CentOS或RHEL安装Go语言：基于 Red Hat 的 Linux 发行版本都可以使用 yum 命令来进行安装：

sudo yum install golang

要查看当前系统安装的 Go 语言版本可以使用如下命令：

go version

# 2. 安装宝塔面板

考虑到服务器，未来会把一些网站搬迁到这个国内的服务器中，为了方便傻瓜式管理。 Centos安装命令：

yum install -y wget && wget -O install.sh http://download.bt.cn/install/install.sh && sh install.sh

Ubuntu/Deepin安装命令：

wget -O install.sh http://download.bt.cn/install/install-ubuntu.sh && sudo bash install.sh

Debian安装命令：

wget -O install.sh http://download.bt.cn/install/install-ubuntu.sh && bash install.sh

Fedora安装命令:

wget -O install.sh http://download.bt.cn/install/install.sh && bash install.sh

# 安装完毕后如果是阿里云或腾讯云，给主机添加端口，在安全组中

安装的具体步骤在这里: 链接 (opens new window)

# 3.安装MySQL

直接在宝塔面板中一键安装即可。

# 4.创建数据库

MinDoc 使用MySQL储存数据，且编码必须是utf8mb4_general_ci。使用面板创建数据库即可。

# 5.系统配置

如果conf目录下不存在 app.conf，将目录下 conf/app.conf.example 重名为 app.conf:。里面保护数据库配置，端口配置等。如果有配置文件而且合适将它上传到/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

1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 6.找到系统的根目录，上传文件

Linux的用户主目录是root文件夹

#可以同ll命令，查看文件夹中的文件
ll 
#使用“cd+文件夹”“cd + 空格”命令，进入文件夹或返回上一层
cd
cd mindoc #进入mindoc文件夹

1
2
3
4
5

# 7.初始化配置

在 MinDoc 根目录下使用命令行执行如下命令，用于初始化数据库：

./mindoc_linux_amd64 install

# 8.反向代理

# 方法一：通过Nginx配置文件设置反向代理

找到Nginx配置文件，正常安装的Nginx在/usr/local/文件夹下，而宝塔面板是在/www/server/文件夹下，找到Nginx/conf/nginx.conf文件，在http中添加下面代码

server {
    listen       80;
    #此处应该配置你的域名：
    server_name  xxx.xxxx.xxx;
    charset utf-8;
    
    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;
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# 方法二：宝塔自带反向代理

快速方便。如果直接修改宝塔Nginx配置文件，会出现各种各样的问题。例如phpmyadmin会出现404的问题。

设置反代目标的URL主要是端口(MinDoc地址与端口是http://127.0.0.1:8181)；
设置目标的域名就是你要配置的域名

# 9. 启动程序

#启动程序
./mindoc_linux_amd64

1
2

# 10.以服务的方式运行MinDoc，服务相关命令

MinDoc 支持在Linux和Windows上以服务的方式后台执行，命令如下：

#安装服务
./mindoc_linux_amd64 service install 

#卸载服务
./mindoc_linux_amd64 service remove

1
2
3
4
5

执行服务安装后，会创建一个以 mindocd 为服务名的服务。

DarinLo's Blog