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

beego document go golang mindoc smartwiki

Go to file

lifei6671 0f1a6f240d 修改样式		2017-05-02 20:13:55 +08:00
Godeps	添加依赖库	2017-04-29 22:06:11 +08:00
commands	添加修改表编码	2017-05-01 20:34:27 +08:00
conf	修改配置文件	2017-05-01 14:53:30 +08:00
controllers	实现搜索功能	2017-05-02 18:09:46 +08:00
data	搭建框架	2017-04-21 18:20:35 +08:00
docs	搭建框架	2017-04-21 18:20:35 +08:00
graphics	完善功能	2017-04-25 20:05:59 +08:00
models	实现搜索功能	2017-05-02 18:09:46 +08:00
routers	实现搜索功能	2017-05-02 18:09:46 +08:00
search	搭建框架	2017-04-21 18:20:35 +08:00
static	修改样式	2017-05-02 20:13:55 +08:00
uploads	添加说明	2017-05-01 21:15:42 +08:00
utils	完善功能	2017-04-25 20:05:59 +08:00
vendor	添加依赖库	2017-04-29 22:06:11 +08:00
views	修改样式	2017-05-02 20:13:55 +08:00
.gitignore	*	2017-04-19 18:19:27 +08:00
Dockerfile	*	2017-05-01 16:04:01 +08:00
LICENSE	Initial commit	2017-04-19 13:37:47 +08:00
README.md	添加说明	2017-05-01 21:15:42 +08:00
main.go	完善评论功能	2017-05-01 19:12:52 +08:00
start.sh	添加项目说明	2017-05-01 21:05:34 +08:00

README.md

MinDoc 简介

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

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

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

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

安装与使用

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

如果有Golang开发经验，建议通过编译安装。

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

go get -d ./...

go build

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

使用Docker部署

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

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

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 -e MYSQL_PORT_3306_TCP_ADDR=127.0.0.1 -e MYSQL_PORT_3306_TCP_PORT=3306 -e MYSQL_INSTANCE_NAME=mindoc_db -e MYSQL_USERNAME=root -e MYSQL_PASSWORD=123456 -e httpport=8181 -d daocloud.io/lifei6671/godoc:latest