2017-05-01 21:05:34 +08:00
|
|
|
|
# MinDoc 简介
|
|
|
|
|
|
|
|
|
|
|
|
MinDoc 是一款针对IT团队开发的简单好用的文档管理系统。
|
|
|
|
|
|
|
|
|
|
|
|
MinDoc 的前身是 SmartWiki 文档系统。SmartWiki 是基于 PHP 框架 laravel 开发的一款文档管理系统。因 PHP 的部署对普通用户来说太复杂，所以改用 Golang 开发。可以方便用户部署和实用。
|
|
|
|
|
|
|
|
|
|
|
|
开发缘起是公司IT部门需要一款简单实用的项目接口文档管理和分享的系统。其功能和界面源于 kancloud 。
|
|
|
|
|
|
|
|
|
|
|
|
可以用来储存日常接口文档，数据库字典，手册说明等文档。内置项目管理，用户管理，权限管理等功能，能够满足大部分中小团队的文档管理需求。
|
|
|
|
|
|
|
|
|
|
|
|
# 安装与使用
|
|
|
|
|
|
|
|
|
|
|
|
对于没有Golang使用经验的用户，可以从 [https://github.com/lifei6671/godoc/releases](https://github.com/lifei6671/godoc/releases) 这里下载编译完的程序。
|
|
|
|
|
|
|
|
|
|
|
|
如果有Golang开发经验，建议通过编译安装。
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
|
git clone https://github.com/lifei6671/godoc.git
|
|
|
|
|
|
|
|
|
|
|
|
go get -d ./...
|
|
|
|
|
|
|
|
|
|
|
|
go build
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
MinDoc 使用MySQL储存数据，且编码必须是`utf8mb4_general_ci`。请在安装前，把数据库配置填充到项目目录下的 conf/app.conf 中。
|
|
|
|
|
|
|
|
|
|
|
|
# 使用Docker部署
|
|
|
|
|
|
|
|
|
|
|
|
如果是Docker用户，可参考项目内置的Dockerfile文件编译镜像。
|
|
|
|
|
|
|
|
|
|
|
|
在启动镜像时需要提供如下的环境变量：
|
|
|
|
|
|
|
|
|
|
|
|
```ini
|
|
|
|
|
|
MYSQL_PORT_3306_TCP_ADDR MySQL地址
|
|
|
|
|
|
MYSQL_PORT_3306_TCP_PORT MySQL端口号
|
|
|
|
|
|
MYSQL_INSTANCE_NAME MySQL数据库名称
|
|
|
|
|
|
MYSQL_USERNAME MySQL账号
|
|
|
|
|
|
MYSQL_PASSWORD MySQL密码
|
|
|
|
|
|
HTTP_PORT 程序监听的端口号
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
举个栗子
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
|
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
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
# 项目截图
|
|
|
|
|
|
|
2017-05-01 21:15:42 +08:00
|
|
|
|
**创建项目**
|
|
|
|
|
|
|
2017-05-01 21:11:36 +08:00
|
|
|
|
|
|
|
|
|
|
|
2017-05-01 21:15:42 +08:00
|
|
|
|
**项目列表**
|
|
|
|
|
|
|
2017-05-01 21:11:36 +08:00
|
|
|
|
|
|
|
|
|
|
|
2017-05-01 21:15:42 +08:00
|
|
|
|
**项目概述**
|
|
|
|
|
|
|
2017-05-01 21:11:36 +08:00
|
|
|
|
|
|
|
|
|
|
|
2017-05-01 21:15:42 +08:00
|
|
|
|
**项目成员**
|
|
|
|
|
|
|
2017-05-01 21:11:36 +08:00
|
|
|
|
|
|
|
|
|
|
|
2017-05-01 21:15:42 +08:00
|
|
|
|
**项目设置**
|
|
|
|
|
|
|
2017-05-01 21:11:36 +08:00
|
|
|
|
|
|
|
|
|
|
|
2017-05-01 21:15:42 +08:00
|
|
|
|
**基于Editor.md开发的Markdown编辑器**
|
|
|
|
|
|
|
2017-05-01 21:11:36 +08:00
|
|
|
|
|
|
|
|
|
|
|
2017-05-01 21:15:42 +08:00
|
|
|
|
**基于wangEditor开发的富文本编辑器**
|
|
|
|
|
|
|
2017-05-01 21:11:36 +08:00
|
|
|
|
|
|
|
|
|
|
|
2017-05-01 21:15:42 +08:00
|
|
|
|
**项目预览**
|
|
|
|
|
|
|
2017-05-01 21:11:36 +08:00
|
|
|
|
|
|
|
|
|
|
|
2017-05-01 21:15:42 +08:00
|
|
|
|
**超级管理员后台**
|
|
|
|
|
|
|
2017-05-01 21:11:36 +08:00
|
|
|
|
|
2017-05-01 21:05:34 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# 使用的技术
|
|
|
|
|
|
|
|
|
|
|
|
- beego 1.8.1
|
|
|
|
|
|
- mysql 5.6
|
|
|
|
|
|
- editor.md
|
|
|
|
|
|
- bootstrap 3.2
|
|
|
|
|
|
- jquery 库
|
|
|
|
|
|
- layer 弹出层框架
|
|
|
|
|
|
- webuploader 文件上传框架
|
|
|
|
|
|
- Nprogress 库
|
|
|
|
|
|
- jstree 树状结构库
|
|
|
|
|
|
- font awesome 字体库
|
|
|
|
|
|
- cropper 图片剪裁库
|
|
|
|
|
|
- layer 弹出层框架
|
|
|
|
|
|
- highlight 代码高亮库
|
|
|
|
|
|
- to-markdown HTML转Markdown库
|
|
|
|
|
|
- wangEditor 富文本编辑器
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# 主要功能
|
|
|
|
|
|
|
|
|
|
|
|
- 项目管理，可以对项目进行编辑更改，成员添加等。
|
|
|
|
|
|
- 文档管理，添加和删除文档等。
|
|
|
|
|
|
- 评论管理，可以管理文档评论和自己发布的评论。
|
|
|
|
|
|
- 用户管理，添加和禁用用户，个人资料更改等。
|
|
|
|
|
|
- 用户权限管理 ， 实现用户角色的变更。
|
|
|
|
|
|
- 项目加密，可以设置项目公开状态，私有项目需要通过Token访问。
|
|
|
|
|
|
- 站点配置，可开启匿名访问、验证码等。
|
|
|
|
|
|
|
|
|
|
|
|
# 参与开发
|
|
|
|
|
|
|
|
|
|
|
|
我们欢迎您在 MinDoc 项目的 GitHub 上报告 issue 或者 pull request。
|
|
|
|
|
|
|
|
|
|
|
|
如果您还不熟悉GitHub的Fork and Pull开发模式，您可以阅读GitHub的文档（https://help.github.com/articles/using-pull-requests） 获得更多的信息。
|
|
|
|
|
|
|
|
|
|
|
|
# 关于作者
|
|
|
|
|
|
|
|
|
|
|
|
一个不纯粹的PHPer，一个不自由的 golanger 。
|
