福否阿卡 · 博客福否阿卡 · 博客

福否阿卡
向往自由与努力生活~

Golang环境部署与MinDoc文档系统搭建

Golang环境部署与MinDoc文档系统搭建

项目简介

MinDoc 是一款针对IT团队开发的简单好用的文档管理系统。

MinDoc 的前身是 SmartWiki 文档系统。SmartWiki 是基于 PHP 框架 laravel 开发的一款文档管理系统。因 PHP 的部署对普通用户来说太复杂,所以改用 Golang 开发。可以方便用户部署和实用,同时增加Markdown和HTML两种编辑器。

开发缘起是公司IT部门需要一款简单实用的项目接口文档管理和分享的系统。其功能和界面源于 kancloud 。

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

官网:https://www.iminho.me/

安装教程(Linux)


搭建Golang环境

下载golang.tar.gz(可以去官网查看你需要的版本号进行改动)

cd /www/server && wget -O golang.tar.gz https://dl.google.com/go/go1.9.2.linux-amd64.tar.gz

解压:

tar -xzvf golang.tar.gz

添加环境变量,使用vim 打开/etc/profile 文件

vim /etc/profile

在profile 最底部添加

export GOROOT=/www/server/go
export GOBIN=$GOROOT/bin
export GOPKG=$GOROOT/pkg/tool/linux_amd64
export GOARCH=amd64
export GOOS=linux
export GOPATH=/www/wwwroot/Golang
export PATH=$PATH:$GOBIN:$GOPKG:$GOPATH/bin

保存退出,然后执行使其生效:

source /etc/profile

查看是否安装成功

go version

出现:go version go1.9.2 linux/amd64 之类的提示就代表安装成功。


安装MinDoc

第一步 下载可执行文件

请从 https://github.com/lifei6671/mindoc/releases 下载最新版的可执行文件,一般文件名为 mindoc_linux_amd.tar.gz

第二步 解压压缩包

请将刚才下载的文件解压,请执行如下命令解压:

tar -xzvf mindoc_linux_amd64.tar.gz

第三步 创建数据库

如果你使用的 mysql 数据库,请创建一个编码为utf8mb4格式的数据库,如果没有GUI管理工具,推荐用下面的脚本创建:

CREATE DATABASE mindoc_db  DEFAULT CHARSET utf8mb4 COLLATE utf8mb4_general_ci;

如果你使用的是 sqlite 数据库,请将 conf/app.conf 中的数据库配置成如下,系统会自动创建 sqlite 数据库文件:

db_adapter=sqlite3
db_database=mindoc_db

第四步 配置数据库

请将刚才解压目录下 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

第五步 启动程序

执行如下命令启动程序:

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

#启动程序
./mindoc_linux_amd64

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

ps:如果访问不了,检查你的8181端口开了没有。

第六步 配置代理

这一步可选,如果你不想用端口号访问 MinDoc 就需要配置一个代理了。

Nginx 代理的配置文件如下:

server {
    listen   80;
    
    #此处应该配置你的域名:
    server_name  doc.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;
    }
}

如果你的网站开启了HTTPS,需要注意参数 X-Forwarded-Proto,如果后端获取到的不是https,请手动设置该参数为https。

总结:

  • 先安装Golang环境
  • 再安装MinDoc
  • 完成!
  • ps:搭配宝塔面板安装数据库就省力多了
本文由福否阿卡创作,文章地址:https://blog.suyc.cn/index.php/archives/90.html

采用知识共享署名3.0国际许可协议进行许可。除注明转载/出处外,均为本站原创或翻译,转载前请务必署名。

发表评论:抢沙发

    昵称 (必填)
  • 邮箱 (必填)
  • 网址