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

news2024/11/26 14:52:47

在这里插入图片描述

什么是 MinDoc ？

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

安装

在群晖上以 Docker 方式安装。

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

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

docker cli 安装

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

# 新建文件夹 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.conf 和 app.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

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=

然后执行下面的命令

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

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

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

# 一键启动
docker-compose up -d