mindoc/README_LINUX.md

109 lines
2.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# Linux 下安装和配置 MinDoc
**第一步 下载可执行文件**
请从 [https://github.com/lifei6671/godoc/releases](https://github.com/lifei6671/godoc/releases) 下载最新版的可执行文件,一般文件名为 godoc_linux_amd.tar.gz .
**第二步 解压压缩包**
请将刚才下载的文件解压,请执行如下命令解压:
```bash
tar -xzvf godoc_linux_amd64.tar.gz
```
**第三步 创建数据库**
请创建一个编码为utf8mb4格式的数据库如果没有GUI管理工具推荐用下面的脚本创建
```sql
CREATE DATABASE mindoc_db DEFAULT CHARSET utf8mb4 COLLATE utf8mb4_general_ci;
```
**第四步 配置数据库**
请将刚才解压目录下 conf/app.conf.example 重名为 app.conf:
```bash
cp conf/app.conf.example conf/app.conf
```
同时配置如下节点:
```ini
#数据库配置
#mysql数据库的IP
db_host=127.0.0.1
#mysql数据库的端口号一般为3306
db_port=3306
#刚才创建的数据库的名称
db_database=mindoc_db
#访问数据库的账号和密码
db_username=root
db_password=123456
```
**第五步 启动程序**
执行如下命令启动程序:
```bash
#修改可执行权限
chmod +x godoc_linux_amd64
#启动程序
./godoc_linux_amd64
```
稍等一分钟程序会自动初始化数据库并创建一个超级管理员账号admin 密码123456
此时访问 http://localhost:8181 就能访问 MinDoc 了。
**第六步 配置代理**
这一步可选,如果你不想用端口号访问 MinDoc 就需要配置一个代理了。
Nginx 代理的配置文件如下:
```ini
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;
}
}
```