推荐一款接口文档在线管理系统

项目简介

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

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

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

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

主要功能

  • 项目管理,可以对项目进行编辑更改,成员添加等。
  • 文档管理,添加和删除文档,文档历史恢复等。
  • 用户管理,添加和禁用用户,个人资料更改等。
  • 用户权限管理 , 实现用户角色的变更。
  • 项目加密,可以设置项目公开状态,私有项目需要通过Token访问。
  • 站点配置,二次开发时可以添加自定义配置项。
  • 附件管理,可管理所有项目中上传的文件。
  • 项目导出,目前支持导出 PDF 格式项目。

主要技术

beego 1.8.0、editor.md、bootstrap 3.2、jquery 1.8、layer 弹出层框架、webuploader 文件上传框架、Nprogress 库、jstree、font awesome 字体库、cropper 图片剪裁库

演示

示例:http://doc.52itstyle.com/

安装环境

centos6.8、MySql5.6、Nginx1.10.3、go1.7.3、GLIBC_2.14

安装数据库

已安装过的请自行忽略。

  1. #查看所有以mysql开头的软件

  2. yum list mysql*

  3. #安装mysql

  4. yum install mysql-server* -y

  5. #启动mysql

  6. /etc/init.d/mysqld start

  7. #设定mysql自动启动

  8. chkconfig mysqld on

  9. #复制mysql的配置文件到etc目录,提示是否覆盖,选择y

  10. cp /usr/share/mysql/my-medium.cnf /etc/my.cnf

  11. #重新设定mysql密码,默认密码是【空】,输入新密码,注意提问,是否删除匿名账户?【y】 是否禁止远程登录?【n】是否移除test数据库?【y】是否重载权限文件【y】

  12. mysql_secure_installation

  13. #重启mysql,此时用本机Navicat Premium还是连不上mysql的!

  14. /etc/init.d/mysqld restart

  15. #用命令访问mysql

  16. mysql -u root -p

  17. #使用mysql数据库

  18. use mysql;

  19. #查询当前用户情况,显示有3条记录,127.0.0.1;localhost;iz28wi3pigtz;其中最后这个是ECS主机名

  20. select host,user from user;

  21. #把localhost这条记录的host改为 %; 意思是root可以由任何主机登录mysql,网上很多写法,都没有and host='localhost'这个条件,经常报错。

  22. update user set host = '%' where user = 'root' and host='localhost';

  23. #再次查询,可以看到host有3个;%;127.0.0.1;iz28wi3pigtz;其实user表的主键是user字段和host字段的联合主键。

  24. select host, user from user;

  25. #重启mysql

  26. /etc/init.d/mysqld restart

安装go环境

一、源码安装

  1. wget https://storage.googleapis.com/golang/go1.7.3.linux-amd64.tar.gz

  2.  
  3. #将文件解压到/use/local/路径下(路径可以自己定义)

  4.  
  5. tar -zxf go1.7.3.linux-amd64.tar.gz -C /usr/local/

配置环境变量

  1. vi /etc/profile

  2. #追加配置

  3. export PATH=$PATH:/usr/local/go/bin

  4. #刷新配置使其生效

  5. source /etc/profile

二、RPM包安装

  1. rpm -Uvh http://dl.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm

  2. yum install golang -y

三、 YUM源安装

yum install -y golang

安装成功后,查看go版本

  1. [root@AY140216149Z ~]# go version

  2. go version go1.7.3 linux/amd64

升级glibc版本

查看glibc版本

  1. [root@AY140216131049Z ~]# strings /lib64/libc.so.6 |grep GLIBC_

  2. GLIBC_2.2.5

  3. GLIBC_2.2.6

  4. GLIBC_2.3

  5. GLIBC_2.3.2

  6. GLIBC_2.3.3

  7. GLIBC_2.3.4

  8. GLIBC_2.4

  9. GLIBC_2.5

  10. GLIBC_2.6

  11. GLIBC_2.7

  12. GLIBC_2.8

  13. GLIBC_2.9

  14. GLIBC_2.10

  15. GLIBC_2.11

  16. GLIBC_2.12

mindoc至少需要2.14版本以上glibc,所以需要自己手动升级

  1. #下载2.14版本

  2. wgte https://ftp.gnu.org/gnu/glibc/glibc-2.14.tar.gz

  3. #解压编译安装

  4. tar -xzvf glibc-2.14.tar.gz

  5. cd glibc-2.14

  6. ./configure --prefix=/opt/glibc-2.14

  7. make && make install

视机器性能,编译安装时间大概需要将近5-10分钟,请耐心等待,安装完成之后

  1. #备份

  2. cp /lib64/libc.so.6 /lib64/libc.so.6.bak

  3. #删除前一定要备份

  4. rm -rf /lib64/libc.so.6

  5. #创建软连接

  6. ln -s /opt/glibc-2.14/lib/libc-2.14.so /lib64/libc.so.6

查看版本,如果发现2.14说明配置成功

  1. [root@AY140216131049Z build]# strings /lib64/libc.so.6 |grep GLIBC_

  2. GLIBC_2.2.5

  3. GLIBC_2.2.6

  4. GLIBC_2.3

  5. GLIBC_2.3.2

  6. GLIBC_2.3.3

  7. GLIBC_2.3.4

  8. GLIBC_2.4

  9. GLIBC_2.5

  10. GLIBC_2.6

  11. GLIBC_2.7

  12. GLIBC_2.8

  13. GLIBC_2.9

  14. GLIBC_2.10

  15. GLIBC_2.11

  16. GLIBC_2.12

  17. GLIBC_2.13

  18. GLIBC_2.14

  19. GLIBC_PRIVATE

安装 mindoc

第一步 下载可执行文件

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

第二步 解压压缩包

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

  1. tar -xzvf mindoc_linux_amd64.tar.gz

  2. unzip mindoc_linux_amd64.zip

第三步 创建数据库

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

CREATE DATABASE mindoc_db  DEFAULT CHARSET utf8mb4 COLLATE utf8mb4_general_ci;

第四步 配置数据库

请将刚才解压目录下 conf/app.conf.example 重名为 app.conf:

cp conf/app.conf.example conf/app.conf
同时配置如下节点:

  1. #数据库配置

  2. db_adapter=mysql

  3. #mysql数据库的IP

  4. db_host=127.0.0.1

  5.  
  6. #mysql数据库的端口号一般为3306

  7. db_port=3306

  8.  
  9. #刚才创建的数据库的名称

  10. db_database=mindoc_db

  11.  
  12. #访问数据库的账号和密码

  13. db_username=root

  14. db_password=123456

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

./mindoc_linux_amd64 install

稍等一分钟,程序会自动初始化数据库,并创建一个超级管理员账号:admin 密码:123456

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

第五步 配置代理

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

Nginx 代理的配置文件如下:

  1. server {

  2. listen 80;

  3. #此处应该配置你的域名:

  4. server_name doc.52itstyle.com;

  5. charset utf-8;

  6. #此处配置你的访问日志,请手动创建该目录:

  7. access_log /var/log/nginx/doc.52itstyle.com.access.log;

  8. location ~ .*\.(ttf|woff2|eot|otf|map|swf|svg|gif|jpg|jpeg|bmp|png|ico|txt|js|css)$ {

  9. #此处将路径执行 MinDoc 的跟目录

  10. root /mnt/domains/mindoc;

  11. expires 30m;

  12. }

  13.  
  14. location / {

  15. try_files /_not_exists_ @backend;

  16. }

  17. # 这里为具体的服务代理配置

  18. location @backend {

  19. proxy_set_header X-Forwarded-For $remote_addr;

  20. proxy_set_header Host $http_host;

  21. proxy_set_header X-Forwarded-Proto $scheme;

  22. #此处配置 MinDoc 程序的地址和端口号

  23. proxy_pass http://127.0.0.1:8181;

  24. }

  25. }

第六步 启动程序

  1. #修改可执行权限

  2. chmod +x mindoc_linux_amd64

  3.  
  4. #后台启动

  5. nohup ./mindoc_linux_amd64 &

  6. # 重启Nginx

  7. nginx -s reload

界面展示:
123.png

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

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值