简单好用的文档管理系统MinDoc

什么是 MinDoc ?

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

安装

在群晖上以 Docker 方式安装。

MinDoc 的镜像发布在阿里云的镜像托管服务上,拉取地址为:

bash 复制代码
# 拉取镜像
docker pull registry.cn-hangzhou.aliyuncs.com/mindoc-org/mindoc:v2.1

docker cli 安装

如果你熟悉命令行,可能用 docker cli 更快捷

bash 复制代码
# 新建文件夹 mindoc 和 子目录
mkdir -p /volume1/docker/mindoc/{conf,database,runtime,static,uploads,views}

# 进入 mindoc 目录
cd /volume1/docker/mindoc

# 运行容器
docker run -d \
   --restart always \
   --name mindoc \
   -p 8185:8181 \
   -v $(pwd)/conf:/mindoc/conf \
   -v $(pwd)/static:/mindoc/static \
   -v $(pwd)/views:/mindoc/views \
   -v $(pwd)/uploads:/mindoc/uploads \
   -v $(pwd)/runtime:/mindoc/runtime \
   -v $(pwd)/database:/mindoc/database \
   -e MINDOC_RUN_MODE=prod \
   -e MINDOC_DB_ADAPTER=sqlite3 \
   -e MINDOC_DB_DATABASE=./database/mindoc.db \
   -e MINDOC_CACHE=true \
   -e MINDOC_CACHE_PROVIDER=file \
   -e MINDOC_ENABLE_EXPORT=false \
   -e MINDOC_BASE_URL= \
   -e MINDOC_CDN_IMG_URL= \
   -e MINDOC_CDN_CSS_URL= \
   -e MINDOC_CDN_JS_URL= \
   registry.cn-hangzhou.aliyuncs.com/mindoc-org/mindoc:v2.1

没有找到关于环境变量的说明,但是可以参考 app.conf.example 文件:https://github.com/mindoc-org/mindoc/blob/master/conf/app.conf.example

安装完成后,可以在 conf 目录中找到 app.confapp.conf.example 文件

如果你想使用 MySQL 做数据库,可以参考 app.conf 文件中的说明;

docker-compose 安装

也可以用 docker-compose 安装,将下面的内容保存为 docker-compose.yml 文件

基于官方的 docker-compose.yml 修改,源文件地址:https://github.com/mindoc-org/mindoc/blob/master/docker-compose.yml

yaml 复制代码
version: "3"

services:
  mindoc:
    image: registry.cn-hangzhou.aliyuncs.com/mindoc-org/mindoc:v2.1
    container_name: mindoc
    privileged: false
    restart: always
    ports:
      - 8185:8181
    volumes:
      - ./conf://mindoc/conf
      - ./static://mindoc/static
      - ./views://mindoc/views
      - ./uploads://mindoc/uploads
      - ./runtime://mindoc/runtime
      - ./database://mindoc/database
    environment:
      - MINDOC_RUN_MODE=prod
      - MINDOC_DB_ADAPTER=sqlite3
      - MINDOC_DB_DATABASE=./database/mindoc.db
      - MINDOC_CACHE=true
      - MINDOC_CACHE_PROVIDER=file
      - MINDOC_ENABLE_EXPORT=false
      - MINDOC_BASE_URL=
      - MINDOC_CDN_IMG_URL=
      - MINDOC_CDN_CSS_URL=
      - MINDOC_CDN_JS_URL=

然后执行下面的命令

bash 复制代码
# 新建文件夹 mindoc 和 子目录
mkdir -p /volume1/docker/mindoc/{conf,database,runtime,static,uploads,views}

# 进入 mindoc 目录
cd /volume1/docker/mindoc

# 将 docker-compose.yml 放入当前目录

# 一键启动
docker-compose up -d

运行

在浏览器中输入 http://群晖IP:8185 就能看到登录界面

默认程序会自动初始化一个超级管理员用户:admin, 密码:123456

进入演示项目,点 编辑 就可以开始编写文档了

功能不复杂,如果不会就去看看官方的说明吧

地址:https://mindoc.com.cn/docs/mindochelp

参考文档

mindoc-org/mindoc: Golang实现的基于beego框架的接口在线文档管理系统

地址:https://github.com/mindoc-org/mindoc
MinDoc文档管理系统 - Powered by MinDoc

地址:https://mindoc.com.cn/
MinDoc 接口文档在线管理系统 - 官方网站

地址:https://www.iminho.me/
MinDoc 简介 - Powered by MinDoc

地址:https://mindoc.com.cn/docs/mindochelp
一款还不错的文档系统

地址:https://mp.weixin.qq.com/s/nQbNEJxLlqCVt9GQ4T6_Dw

相关推荐
ZHOU西口几秒前
微服务实战系列之玩转Docker(十八)
分布式·docker·云原生·架构·数据安全·etcd·rbac
Yawesh_best1 小时前
思源笔记轻松连接本地Ollama大语言模型,开启AI写作新体验!
笔记·语言模型·ai写作
一个处女座的程序猿2 小时前
LLMs之PDF:zeroX(一款PDF到Markdown 的视觉模型转换工具)的简介、安装和使用方法、案例应用之详细攻略
pdf·markdown·zerox
CXDNW2 小时前
【网络面试篇】HTTP(2)(笔记)——http、https、http1.1、http2.0
网络·笔记·http·面试·https·http2.0
使者大牙2 小时前
【大语言模型学习笔记】第一篇:LLM大规模语言模型介绍
笔记·学习·语言模型
ssf-yasuo2 小时前
SPIRE: Semantic Prompt-Driven Image Restoration 论文阅读笔记
论文阅读·笔记·prompt
ajsbxi3 小时前
苍穹外卖学习记录
java·笔记·后端·学习·nginx·spring·servlet
TeYiToKu3 小时前
笔记整理—linux驱动开发部分(9)framebuffer驱动框架
linux·c语言·arm开发·驱动开发·笔记·嵌入式硬件·arm
dsywws3 小时前
Linux学习笔记之时间日期和查找和解压缩指令
linux·笔记·学习
cuisidong19975 小时前
5G学习笔记三之物理层、数据链路层、RRC层协议
笔记·学习·5g