Minho 8 лет назад
Родитель
Сommit
62fc4d09a1
5 измененных файлов с 1 добавлено и 257 удалено
  1. 1 5
      README.md
  2. 0 3
      docs/README.md
  3. 0 119
      docs/README_LINUX.md
  4. 0 104
      docs/README_WIN.md
  5. 0 26
      docs/WKHTMLTOPDF.md

+ 1 - 5
README.md

@@ -16,11 +16,7 @@ MinDoc 的前身是 SmartWiki 文档系统。SmartWiki 是基于 PHP 框架 lara
 
 **如果你的服务器上没有安装golang程序请手动设置一个环境变量如下:键名为 ZONEINFO,值为MinDoc跟目录下的/lib/time/zoneinfo.zip 。**
 
-**Windows 教程:** [https://github.com/lifei6671/godoc/blob/master/README_WIN.md](docs/README_WIN.md)
-
-**Linux  教程:**  [https://github.com/lifei6671/godoc/blob/master/README_LINUX.md](docs/README_LINUX.md)
-
-**PDF 导出配置教程**  [https://github.com/lifei6671/godoc/blob/master/docs/README_LINUX.md](docs/WKHTMLTOPDF.md)
+更多信息请查看手册: [MinDoc 使用手册](https://github.com/lifei6671/godoc/wiki/MinDoc-%E4%BD%BF%E7%94%A8%E6%89%8B%E5%86%8C)
 
 对于没有Golang使用经验的用户,可以从 [https://github.com/lifei6671/godoc/releases](https://github.com/lifei6671/godoc/releases) 这里下载编译完的程序。
 

+ 0 - 3
docs/README.md

@@ -1,3 +0,0 @@
-## 文档缓存目录
-
-文档在发布后会自动缓存到该目录。如果使用nginx代理,可不经过 MinDoc 即可访问文档。也可以拷贝出去当成单独项目使用。

+ 0 - 119
docs/README_LINUX.md

@@ -1,119 +0,0 @@
-# Linux 下安装和配置 MinDoc
-
-**如果你的服务器上没有安装golang程序请手动设置一个环境变量如下:键名为 ZONEINFO,值为MinDoc跟目录下的/lib/time/zoneinfo.zip 绝对路径。**
-
-**第一步 下载可执行文件**
-
-请从 [https://github.com/lifei6671/godoc/releases](https://github.com/lifei6671/godoc/releases)  下载最新版的可执行文件,一般文件名为 godoc_linux_amd.tar.gz 或 godoc_linux_amd64.zip 。
-
-**第二步 解压压缩包**
-
-请将刚才下载的文件解压,请执行如下命令解压:
-
-```bash
-tar -xzvf godoc_linux_amd64.tar.gz
-或
-unzip godoc_linux_amd64.zip
-```
-
-**第三步 创建数据库**
-
-请创建一个编码为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
-
-```
-
-在 MinDoc 根目录下使用命令行执行如下命令,用于初始化数据库:
-
-```bash
-./godoc_linux_amd64 install
-```
-
-
-**第五步 启动程序**
-
-执行如下命令启动程序:
-
-```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;
-    }
-}
-
-```

+ 0 - 104
docs/README_WIN.md

@@ -1,104 +0,0 @@
-# Windows 下安装和配置 MinDoc
-
-**如果你的服务器上没有安装golang程序请手动设置一个环境变量如下:键名为 ZONEINFO,值为MinDoc跟目录下的/lib/time/zoneinfo.zip 绝对路径。**
-
-**第一步 下载可执行文件**
-
-请从 [https://github.com/lifei6671/godoc/releases](https://github.com/lifei6671/godoc/releases)  下载最新版的可执行文件,一般文件名为 godoc_windows_amd.zip .
-
-**第二步 解压压缩包**
-
-请将刚才下载的文件解压,推荐使用好压解压到任意目录。建议不用用中文明明目录名称。
-
-**第三步 创建数据库**
-
-请创建一个编码为utf8mb4格式的数据库,如果没有GUI管理工具,推荐用下面的脚本创建:
-
-```sql
-CREATE DATABASE mindoc_db  DEFAULT CHARSET utf8mb4 COLLATE utf8mb4_general_ci;
-```
-
-**第四步 配置数据库**
-
-请将刚才解压目录下 conf/app.conf.example 重名为 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
-
-```
-
-在 MinDoc 根目录下使用命令行执行如下命令,用于初始化数据库:
-
-```bash
-godoc_windows_amd64.exe install
-```
-
-**第五步 启动程序**
-
-如果你设置了环境变量,但是没有重启电脑,请在cmd命令行启动 godoc_windows_amd64.exe 程序。
-
-如果你设置了环境变量,并且重启了电脑,双击 godoc_windows_amd64.exe 即可。
-
-稍等一分钟,程序会自动初始化数据库,并创建一个超级管理员账号:admin 密码:123456
-
-此时访问 http://localhost:8181 就能访问 MinDoc 了。
-
-**第六步 配置代理**
-
-这一步可选,如果你不想用端口号访问 MinDoc 就需要配置一个代理了。
-
-推荐使用nginx做前端代理,当然,也可以用IIS做代理。
-
-IIS的代理教程请参见 : [http://blog.csdn.net/yuanguozhengjust/article/details/23576033?utm_source=tuicool&utm_medium=referral](http://blog.csdn.net/yuanguozhengjust/article/details/23576033?utm_source=tuicool&utm_medium=referral)
-
-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;
-    }
-}
-
-```

+ 0 - 26
docs/WKHTMLTOPDF.md

@@ -1,26 +0,0 @@
-## wkhtmltopdf 安装
-
-导出 pdf 格式文档使用的是 wkhtmltopdf 工具,工具下载地址为:[https://wkhtmltopdf.org/downloads.html](https://wkhtmltopdf.org/downloads.html)。
-
-### Windows 下配置
-
-下载 Windows 版本,安装即可。
-
-### Linux 下配置
-
-请下载和你服务器对应的版本,Linux版本依赖一下库:
-
-`zlib fontconfig freetype X11 libs (libX11, libXext, libXrender)`
-
-请自行搜索安装以上依赖包,下面的命令是安装 libXrender 和 libXext。
-
-```bash
-apt-get install -y libxrender-dev
-apt-get install -y libxext-dev
-```
-
-## 配置
-
-请将 wkhtmltopdf 可执行文件所在目录配置到 MinDoc 根目录下 conf/app.conf 的 wkhtmltopdf 节点。
-
-配置完后请重启程序。