安利一款接口文档在线管理系统-MinDoc

项目简介

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

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

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

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

主要功能

  • 项目管理,可以对项目进行编辑更改,成员添加等。

  • 文档管理,添加和删除文档,文档历史恢复等。

  • 用户管理,添加和禁用用户,个人资料更改等。

  • 用户权限管理 , 实现用户角色的变更。

  • 项目加密,可以设置项目公开状态,私有项目需要通过Token访问。

  • 站点配置,二次开发时可以添加自定义配置项。

  • 附件管理,可管理所有项目中上传的文件。

    扫描二维码关注公众号,回复: 12728071 查看本文章
  • 项目导出,目前支持导出 PDF 格式项目。

图片


环境

  • CentOS7

  • Docker

过程

  1. 下载mindoc的执行程序,然后解压

wget -c https://github.com/lifei6671/mindoc/releases/download/v0.12/mindoc_linux_amd64.zipunzip mindoc_linux_amd64.zip
  1. 使用Docker创建数据库

创建MysqL容器,在本地安装mysql客户端,连接mysql,然后创建数据库

docker run --name mindoc -d -p3310:3306 -e MYSQL_ROOT_PASSWORD=123456 mysql:5.6
yum install mariadb
mysql -uroot -h192.168.99.100 -P3310 -p123456
CREATE DATABASE mindoc_db  DEFAULT CHARSET utf8mb4 COLLATE utf8mb4_general_ci;
  1. 在刚才解压的mindoc目录,在配置目录下修改配置文件

#支持MySQL和sqlite3两种数据库,如果是sqlite3 则 db_database 标识数据库的物理目录db_adapter=mysql
db_host=127.0.0.1
db_port=3310
db_database=mindoc_db
db_username=root
db_password=123456
  1. 初始化Mindoc的数据库

./mindoc_linux_amd64 install
  1. 直接在本地安装Nginx,并发一定要使用Nginx,只要能提供反向代理功能。如果直接能在本地访问当然也是可以的,那样就不用配置Nginx了,因为我是在虚拟机中配置的,无法方法虚拟机内部,因此要安装nginx。

yum install epel*
yum install nginx
vim /etc/nginx/nginx.conf


location / {
    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;}
  1. 测试
    默认账号是admin,123456


    图片


图片


图片



图片


  1. 剩下的自己进入后台摸索就好了,官方文档给的说明很详细啊

最后

碰到还不错的软件,只停留在知道上没什么用处,亲自搭建一下动动手,让自己理解的更透彻。


猜你喜欢

转载自blog.51cto.com/15060546/2651582