引言

最近因为前端在异地，所以实行异地开发，但是由于接口文档交接难受，偶然间发现了这个开源项目，试试还挺好用的

本文章使用的是MySQL+go，如果没有安装go，可以移步到这里安装：Linux源码安装go

下载安装

下载

点击安装最新版：https://github.com/lifei6671/mindoc/releases

如果上面的链接不能打开，就点击这里下载：点击下载

解压

下载完成后，解压至指定目录

unzip /server/sourceCode/mindoc_linux_amd64.zip -d /server/project/mindoc

配置

数据库

首先进入mysql，然后创建数据库

CREATE DATABASE mindoc_db  DEFAULT CHARSET utf8mb4 COLLATE utf8mb4_general_ci;

创建用户并设置新建数据库的管理权

USE mindoc_db;
CREATE USER '用户名'@'localhost' IDENTIFIED BY '用户密码';
GRANT ALL PRIVILEGES ON mindoc_db.* TO '用户名'@'localhost';
FLUSH PRIVILEGES;

项目配置

进入项目根目录，打开配置文件

vi ./conf/app.conf

找到数据库配置，然后根据创建的数据库信息配置

db_adapter=mysql
db_host=127.0.0.1
db_port=端口
db_database=mindoc_db
db_username=用户名
db_password=用户密码

确定路径是自己域名

baseurl="http://47.120.4.193:8182"

安装

在项目根目录输入

./mindoc_linux_amd64 install

看到这个就说明安装成功了

安装过程中会自动初始化数据库，并创建一个超级管理员账号：admin 密码：123456

启动与配置代理

启动

修改可执行权限

chmod +x mindoc_linux_amd64

启动程序

./mindoc_linux_amd64

配置代理

我这里使用的是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:8182;
    }
}

后台启动

nohup ./mindoc_linux_amd64 > ./mindoc.log 2>&1 &

查看端口pid号

lsof -i :8182

至此就安装成功啦