推荐一款接口文档在线管理系统-MinDoc
2017-09-08 18:17
537 查看
项目简介
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安装数据库
已安装过的请自行忽略。#查看所有以mysql开头的软件 yum list mysql* #安装mysql yum install mysql-server* -y #启动mysql /etc/init.d/mysqld start #设定mysql自动启动 chkconfig mysqld on #复制mysql的配置文件到etc目录,提示是否覆盖,选择y cp /usr/share/mysql/my-medium.cnf /etc/my.cnf #重新设定mysql密码,默认密码是【空】,输入新密码,注意提问,是否删除匿名账户?【y】 是否禁止远程登录?【n】是否移除test数据库?【y】是否重载权限文件【y】 mysql_secure_installation #重启mysql,此时用本机Navicat Premium还是连不上mysql的! /etc/init.d/mysqld restart #用命令访问mysql mysql -u root -p #使用mysql数据库 use mysql; #查询当前用户情况,显示有3条记录,127.0.0.1;localhost;iz28wi3pigtz;其中最后这个是ECS主机名 select host,user from user; #把localhost这条记录的host改为 %; 意思是root可以由任何主机登录mysql,网上很多写法,都没有and host='localhost'这个条件,经常报错。 update user set host = '%' where user = 'root' and host='localhost'; #再次查询,可以看到host有3个;%;127.0.0.1;iz28wi3pigtz;其实user表的主键是user字段和host字段的联合主键。 select host, user from user; #重启mysql /etc/init.d/mysqld restart
安装go环境
一、源码安装wget https://storage.googleapis.com/golang/go1.7.3.linux-amd64.tar.gz #将文件解压到/use/local/路径下(路径可以自己定义) tar -zxf go1.7.3.linux-amd64.tar.gz -C /usr/local/
配置环境变量
vi /etc/profile #追加配置 export PATH=$PATH:/usr/local/go/bin #刷新配置使其生效 source /etc/profile
二、RPM包安装
rpm -Uvh http://dl.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm yum install golang -y
三、 YUM源安装
yum install -y golang
安装成功后,查看go版本
[root@AY140216149Z ~]# go version go version go1.7.3 linux/amd64
升级glibc版本
查看glibc版本[root@AY140216131049Z ~]# strings /lib64/libc.so.6 |grep GLIBC_ GLIBC_2.2.5 GLIBC_2.2.6 GLIBC_2.3 GLIBC_2.3.2 GLIBC_2.3.3 GLIBC_2.3.4 GLIBC_2.4 GLIBC_2.5 GLIBC_2.6 GLIBC_2.7 GLIBC_2.8 GLIBC_2.9 GLIBC_2.10 GLIBC_2.11 GLIBC_2.12
mindoc至少需要2.14版本以上glibc,所以需要自己手动升级
#下载2.14版本 wgte https://ftp.gnu.org/gnu/glibc/glibc-2.14.tar.gz #解压编译安装 tar -xzvf glibc-2.14.tar.gz cd glibc-2.14 ./configure --prefix=/opt/glibc-2.14 make && make install
视机器性能,编译安装时间大概需要将近5-10分钟,请耐心等待,安装完成之后
#备份 cp /lib64/libc.so.6 /lib64/libc.so.6.bak #删除前一定要备份 rm -rf /lib64/libc.so.6 #创建软连接 ln -s /opt/glibc-2.14/lib/libc-2.14.so /lib64/libc.so.6
查看版本,如果发现2.14说明配置成功
[root@AY140216131049Z build]# strings /lib64/libc.so.6 |grep GLIBC_ GLIBC_2.2.5 GLIBC_2.2.6 GLIBC_2.3 GLIBC_2.3.2 GLIBC_2.3.3 GLIBC_2.3.4 GLIBC_2.4 GLIBC_2.5 GLIBC_2.6 GLIBC_2.7 GLIBC_2.8 GLIBC_2.9 GLIBC_2.10 GLIBC_2.11 GLIBC_2.12 GLIBC_2.13 GLIBC_2.14 GLIBC_PRIVATE
安装 mindoc
第一步 下载可执行文件请从 https://github.com/lifei6671/mindoc/releases 下载最新版的可执行文件,一般文件名为 mindoc_linux_amd.tar.gz 或 mindoc_linux_amd64.zip 。
第二步 解压压缩包
请将刚才下载的文件解压,请执行如下命令解压:
tar -xzvf mindoc_linux_amd64.tar.gz 或 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
同时配置如下节点:
#数据库配置 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
此时访问 http://localhost:8181 就能访问 MinDoc 了。
第五步 配置代理
这一步可选,如果你不想用端口号访问 MinDoc 就需要配置一个代理了。
Nginx 代理的配置文件如下:
server { listen 80; #此处应该配置你的域名: server_name doc.52itstyle.com; charset utf-8; #此处配置你的访问日志,请手动创建该目录: access_log /var/log/nginx/doc.52itstyle.com.access.log; location ~ .*\.(ttf|woff2|eot|otf|map|swf|svg|gif|jpg|jpeg|bmp|png|ico|txt|js|css)$ { #此处将路径执行 MinDoc 的跟目录 root /mnt/domains/mindoc; 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; } }
第六步 启动程序
#修改可执行权限 chmod +x mindoc_linux_amd64 #后台启动 nohup ./mindoc_linux_amd64 & # 重启Nginx nginx -s reload
界面展示:
相关文章推荐
- 推荐一款接口文档在线管理系统-MinDoc
- MinDoc 接口文档在线管理系统
- swagger-ui等接口文档在线管理工具
- 几款常用的在线API管理工具(是时候抛弃office编写接口文档了)
- ,有一款RESTFUL接口的文档在线自动生成+功能测试功能软件——Swagger UI,具体配置过程可移步《Spring Boot 利用 Swagger 实现restful测试》
- 一款RESTFUL接口的文档在线自动生成+功能测试功能软件——Swagger简介
- JavaWeb企业在线文档管理系统
- 艳辉接口文档管理系统
- 推荐一个公司内部接口文档管理方案
- Swagger 一款RESTFUL接口的文档在线自动生成+功能测试功能软件
- .NET开源项目 QuarkDoc 一款自带极简主义属性的文档管理系统
- eoLinker-AMS接口管理系统 API文档管理教程
- [置顶] swagger-ui、taobao rap 等接口文档在线管理工具
- SmartWiki文档在线管理系统简介
- 【项目记录】山东大学场馆管理系统之——需求分析、接口文档
- 企业文档管理系统 SeedDMS安装配置推荐使用
- 在线文档管理系统
- 用fso和session统计在线人数 文档管理系统 V2.0
- eoLinker-AMS接口管理系统 项目文档管理教程
- 推荐一款linux服务器管理系统