Golang实现的基于beego框架的接口在线文档管理系统
 
 
 
Go to file
张胜 77fccc637a
fix: cherry_markdown error (#908)
* fix: first open document, cherryMarkdown not have theme

* fix: modify prismjs style and improve image clarity

* update cherry-markdown

* optimiztion: cherry-markdown

* feat: cherry-markdown add auto-save and update icon

* fix: the mobile phone displays abnormally and Markdown does not allow conversion

---------

Co-authored-by: zhangsheng.93 <zhangsheng.93@bytedance.com>
2023-11-20 17:31:45 +08:00
.github fix: cherry_markdown error (#908) 2023-11-20 17:31:45 +08:00
cache fix(document): fail to count times when cache is enabled. 2021-04-25 16:05:05 +08:00
commands 初始化日志模块时应先重置beego默认的logger (#823) 2023-08-23 10:22:02 +08:00
conf fix: cherry_markdown error (#908) 2023-11-20 17:31:45 +08:00
controllers fix: cherry_markdown error (#908) 2023-11-20 17:31:45 +08:00
converter chore!(all): update go import path 2021-03-23 15:09:17 +08:00
graphics 修复项目图标上传的BUG 2021-09-07 17:06:20 +08:00
lib/time 集成时区包 2017-05-09 10:18:10 +08:00
mail chore: use core/logs 2021-03-26 14:26:19 +08:00
models chore: use fmt.Errorf(...) instead of errors.New(fmt.Sprintf(...)) 2023-07-07 11:00:36 +08:00
routers 重写Auth2.0登录逻辑 (#851) 2023-04-20 13:24:28 +08:00
static fix: cherry_markdown error (#908) 2023-11-20 17:31:45 +08:00
uploads refactor:重构错误页,优化编辑器,上传新效果图 2018-08-17 18:05:04 +08:00
utils fix: cherry_markdown error (#908) 2023-11-20 17:31:45 +08:00
views 项目空间数量超过分页数量后不显示的bug修复 2023-08-09 10:51:06 +08:00
.gitattributes perf:增加右键提示 2018-11-14 16:31:32 +08:00
.gitignore 提升Go版本, 添加Linux编译脚本 2022-05-13 17:19:28 +08:00
.travis.yml 移动favicon.ico到static目录 2022-07-20 15:04:01 +08:00
Dockerfile Dockerfile中calibre强制使用5.44.0版本 2023-05-04 15:17:25 +08:00
LICENSE.md Create LICENSE.md 2017-06-14 09:18:07 +08:00
README.md 添加对 mindoc-daemon 的支持 2023-05-22 17:40:07 +08:00
appveyor.yml 移动favicon.ico到static目录 2022-07-20 15:04:01 +08:00
build_amd64.sh 移动favicon.ico到static目录 2022-07-20 15:04:01 +08:00
build_musl_amd64.sh 移动favicon.ico到static目录 2022-07-20 15:04:01 +08:00
dev-win-build.cmd ldap登录时支持邮箱作为账户 2022-09-02 10:41:35 +08:00
docker-compose.yml v2.1 docker 信息更新 2022-07-25 13:40:16 +08:00
go.mod 临时解决阅读页面js报错'menuSetting undefined' 2023-04-17 14:25:11 +08:00
go.sum 临时解决阅读页面js报错'menuSetting undefined' 2023-04-17 14:25:11 +08:00
main.go 添加对 mindoc-daemon 的支持 2023-05-22 17:40:07 +08:00
simsun.ttc 增加中文字体 2018-07-18 17:53:49 +08:00
start.sh Dockerfile更新 v2.1 2022-07-25 11:56:55 +08:00

README.md

MinDoc 简介

Build Status Build status

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

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

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

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

演示站点&文档:

开发&维护&使用 悉知


安装与使用

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

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

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

如果有Golang开发经验建议通过编译安装要求golang版本不小于1.15.1(需支持CGOgo modimport _ "time/tzdata")(推荐Go版本为1.18.1)。

注意: CentOS7上GLibC版本低常规编译版本不能使用。需要自行源码编译,或使用使用musl编译版本。

常规编译

# 克隆源码
git clone https://github.com/mindoc-org/mindoc.git
# go包安装
go mod tidy -v
# 编译(sqlite需要CGO支持)
go build -ldflags "-w" -o mindoc main.go
# 数据库初始化(此步骤执行之前,需配置`conf/app.conf`)
./mindoc install
# 执行
./mindoc
# 开发阶段运行
bee run

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

如果使用 SQLite 数据库,则直接在配置文件中配置数据库路径即可.

如果conf目录下不存在 app.conf 请重命名 app.conf.exampleapp.conf

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

Linux系统中不依赖gLibC的编译方式

安装 musl-gcc

wget -c http://musl.libc.org/releases/musl-1.2.2.tar.gz
tar -xvf musl-1.2.2.tar.gz
cd musl-1.2.2
./configure
make
sudo make install

使用 musl-gcc 编译 mindoc

go mod tidy -v
export GOARCH=amd64
export GOOS=linux
# 设置使用musl-gcc
export CC=/usr/local/musl/bin/musl-gcc
# 设置版本
export TRAVIS_TAG=temp-musl-v`date +%y%m%d`
go build -v -o mindoc_linux_musl_amd64 -ldflags="-linkmode external -extldflags '-static' -w -X 'github.com/mindoc-org/mindoc/conf.VERSION=$TRAVIS_TAG' -X 'github.com/mindoc-org/mindoc/conf.BUILD_TIME=`date`' -X 'github.com/mindoc-org/mindoc/conf.GO_VERSION=`go version`'"
# 验证
./mindoc_linux_musl_amd64 version

Windows 上后台运行

使用 mindoc-daemon

#邮件配置-示例
#是否启用邮件
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文件自行编译镜像(编译命令见Dockerfile文件底部注释仅供参考)。

在启动镜像时需要提供如下的常用环境变量(全部支持的环境变量请参考: conf/app.conf.example)

DB_ADAPTER                  指定DB类型(默认为sqlite)
MYSQL_PORT_3306_TCP_ADDR    MySQL地址
MYSQL_PORT_3306_TCP_PORT    MySQL端口号
MYSQL_INSTANCE_NAME         MySQL数据库名称
MYSQL_USERNAME              MySQL账号
MYSQL_PASSWORD              MySQL密码
HTTP_PORT                   程序监听的端口号
MINDOC_ENABLE_EXPORT        开启导出(默认为false)

举个栗子-当前(公开)镜像(信息页面: https://cr.console.aliyun.com/images/cn-hangzhou/mindoc-org/mindoc/detail , 需要登录阿里云账号才可访问列表)

Windows
set MINDOC=//d/mindoc
docker run -it --name=mindoc --restart=always -v "%MINDOC%/conf":"/mindoc/conf" -p 8181:8181 -e MINDOC_ENABLE_EXPORT=true -d registry.cn-hangzhou.aliyuncs.com/mindoc-org/mindoc:v2.1
Linux、Mac
export MINDOC=/home/ubuntu/mindoc-docker
docker run -it --name=mindoc --restart=always -v "${MINDOC}/conf":"/mindoc/conf" -p 8181:8181 -e MINDOC_ENABLE_EXPORT=true -d registry.cn-hangzhou.aliyuncs.com/mindoc-org/mindoc:v2.1
举个栗子-更多环境变量示例(镜像已过期,仅供参考,请以当前镜像为准)
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

dockerfile内容参考

docker-compose 一键安装

  1. 修改配置文件 修改docker-compose.yml中的配置信息,主要修改volumes节点,将宿主机的两个目录映射到容器内。 environment节点,配置自己的环境变量。

  2. 一键完成所有环境搭建

    docker-compose up -d

  3. 浏览器访问

    http://localhost:8181/

    整个部署完成了

  4. 常用命令参考

    • 启动

      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 的使用相关的内容 请查看官网文档或百度

项目截图

创建项目

创建项目

项目列表

项目列表

项目概述

项目概述

项目成员

项目成员

项目设置

项目设置

基于Editor.md开发的Markdown编辑器

基于Editor.md开发的Markdown编辑器

基于wangEditor开发的富文本编辑器

基于wangEditor开发的富文本编辑器

项目预览

项目预览

超级管理员后台

超级管理员后台

使用的技术(TODO: 最新技术栈整理中,使用的第三方库升级中)

主要功能

  • 项目管理,可以对项目进行编辑更改,成员添加等。
  • 文档管理,添加和删除文档等。
  • 评论管理,可以管理文档评论和自己发布的评论。
  • 用户管理,添加和禁用用户,个人资料更改等。
  • 用户权限管理 实现用户角色的变更。
  • 项目加密可以设置项目公开状态私有项目需要通过Token访问。
  • 站点配置,可开启匿名访问、验证码等。

参与开发

我们欢迎您在 MinDoc 项目的 GitHub 上报告 issue 或者 pull request。

如果您还不熟悉GitHub的Fork and Pull开发模式您可以阅读GitHub的文档https://help.github.com/articles/using-pull-requests 获得更多的信息。

关于作者lifei6671

一个不纯粹的PHPer一个不自由的 gopher 。