Golang实现的基于beego框架的接口在线文档管理系统

beego document go golang mindoc smartwiki

Go to file

lifei6671 7785fb270d fix:修复beego使用file储存session时存在的路径BUG		2018-11-09 18:10:34 +08:00
.github	*	2017-06-14 17:05:58 +08:00
cache	fix:修复旧版本没有标识文档读写缓存失败的BUG	2018-08-13 15:04:52 +08:00
commands	fix:修复beego使用file储存session时存在的路径BUG	2018-11-09 18:10:34 +08:00
conf	feat:实现团队功能	2018-11-05 18:50:01 +08:00
controllers	feat:实现团队功能	2018-11-08 20:08:30 +08:00
converter	1、完善日志配置	2018-07-25 14:46:56 +08:00
graphics	1、实现富文本编辑器	2018-01-26 17:17:38 +08:00
lib/time	集成时区包	2017-05-09 10:18:10 +08:00
mail	优化代码	2018-02-05 13:41:24 +08:00
models	feat:实现团队功能	2018-11-08 20:08:30 +08:00
routers	fix:修复beego使用file储存session时存在的路径BUG	2018-11-09 18:10:34 +08:00
static	fix:修复文章导航显示不全的BUG	2018-09-27 18:18:02 +08:00
uploads	refactor:重构错误页，优化编辑器，上传新效果图	2018-08-17 18:05:04 +08:00
utils	fix:兼容老文档的TOC	2018-09-14 10:24:41 +08:00
views	feat:实现团队功能	2018-11-08 20:08:30 +08:00
.gitattributes	1. 因编译遇到问题目录结构调整回来了，后期学习go知识来调整新目录	2018-01-06 15:43:39 +08:00
.gitignore	将包版本管理工具切换为官方的dep	2018-03-06 13:47:51 +08:00
.travis.yml	增加中文字体	2018-07-18 17:56:33 +08:00
Dockerfile	fix:修复Dockerfile文件	2018-09-17 18:21:25 +08:00
Gopkg.toml	fix:修复beego使用file储存session时存在的路径BUG	2018-11-09 18:10:34 +08:00
LICENSE.md	Create LICENSE.md	2017-06-14 09:18:07 +08:00
README.md	docs:完善文档	2018-10-19 17:26:40 +08:00
appveyor.yml	更新golang版本	2018-07-11 10:18:34 +08:00
docker-compose.yml	fix:同步docker compose配置文件	2018-08-20 14:27:24 +08:00
favicon.ico	添加favicon	2017-05-03 14:32:18 +08:00
main.go	修改包引用	2017-06-14 09:23:29 +08:00
simsun.ttc	增加中文字体	2018-07-18 17:53:49 +08:00
start.sh	fix:修复Dockerfile文件	2018-09-17 18:22:41 +08:00

README.md

MinDoc 简介

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

MinDoc 的前身是 SmartWiki 文档系统。SmartWiki 是基于 PHP 框架 laravel 开发的一款文档管理系统。因 PHP 的部署对普通用户来说太复杂，所以改用 Golang 开发。可以方便用户部署和实用。

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

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

演示站点： http://doc.iminho.me

安装与使用

如果你的服务器上没有安装golang程序请手动设置一个环境变量如下：键名为 ZONEINFO，值为MinDoc跟目录下的/lib/time/zoneinfo.zip 。

更多信息请查看手册： MinDoc 使用手册

对于没有Golang使用经验的用户，可以从 https://github.com/lifei6671/mindoc/releases 这里下载编译完的程序。

如果有Golang开发经验，建议通过编译安装，在此之前，您需要先安装Golang官方包管理工具，详见Install dep。

git clone https://github.com/lifei6671/mindoc.git

dep ensure

go build -ldflags "-w"

./mindoc install

./mindoc

MinDoc 使用MySQL储存数据，且编码必须是utf8mb4_general_ci。请在安装前，把数据库配置填充到项目目录下的 conf/app.conf 中。

如果conf目录下不存在 app.conf 请重命名 app.conf.example 为 app.conf。

默认程序会自动初始化一个超级管理员用户：admin 密码：123456 。请登录后重新设置密码。


#邮件配置
#是否启用邮件
enable_mail=true
#smtp服务器的账号
smtp_user_name=admin@iminho.me
#smtp服务器的地址
smtp_host=smtp.ym.163.com
#密码
smtp_password=1q2w3e__ABC
#端口号
smtp_port=25
#邮件发送人的地址
form_user_name=admin@iminho.me
#邮件有效期30分钟
mail_expired=30

使用Docker部署

如果是Docker用户，可参考项目内置的Dockerfile文件编译镜像。

在启动镜像时需要提供如下的环境变量：

DB_ADAPTER                  制定 DB
MYSQL_PORT_3306_TCP_ADDR    MySQL地址
MYSQL_PORT_3306_TCP_PORT    MySQL端口号
MYSQL_INSTANCE_NAME         MySQL数据库名称
MYSQL_USERNAME              MySQL账号
MYSQL_PASSWORD              MySQL密码
HTTP_PORT                   程序监听的端口号

举个栗子

docker run -p 8181:8181 --name mindoc -e DB_ADAPTER=mysql -e MYSQL_PORT_3306_TCP_ADDR=10.xxx.xxx.xxx -e MYSQL_PORT_3306_TCP_PORT=3306 -e MYSQL_INSTANCE_NAME=mindoc -e MYSQL_USERNAME=root -e MYSQL_PASSWORD=123456 -e httpport=8181 -d daocloud.io/lifei6671/mindoc:latest

docker-compose 一键安装

修改配置文件修改docker-compose.yml中的配置信息，主要修改volumes节点，将宿主机的两个目录映射到容器内。 environment节点，配置自己的环境变量。
一键完成所有环境搭建

docker-compose up -d
浏览器访问

http://localhost:8181/

整个部署完成了
常用命令参考
- 启动
  
  docker-compose up -d
- 停止
  
  docker-compose stop
- 重启
  
  docker-compose restart
- 停止删除容器，释放所有资源
  
  docker-compose down
- 删除并重新创建
  
  docker-compose -f docker-compose.yml down && docker-compose up -d 更多 docker-compose 的使用相关的内容请查看官网文档或百度