Docker 部署 MinDoc 文档管理系统 📝☁️

📋 目录导航

🎯 项目简介

MinDoc 是一款针对IT团队开发的简单好用的文档管理系统，适合用来储存日常接口文档、数据库字典、手册说明等文档。内置项目管理、用户管理、权限管理等功能，支持Markdown格式，能够满足中小型团队对文档管理的基本需求。

🛠️ 核心特性

特性类别 功能描述 优势
📚 项目管理 支持多项目文档管理 清晰区分不同项目文档，便于组织和管理
👥 用户权限 多用户协作和权限控制 支持团队成员协作，设置不同访问权限
📝 Markdown 支持 完整的Markdown编辑器 熟悉的语法，流畅的写作体验
🔍 全文搜索 支持文档内容全文检索 快速定位所需文档内容
📊 文档统计 文档数量和字数统计 直观了解项目文档情况
🌐 在线预览 支持文档实时预览 编写同时查看最终效果
📤 导出功能 支持多种格式导出 方便文档的分享和备份
🎨 主题样式 多种界面主题可选 个性化定制界面风格

🐳 一、Docker 部署 MinDoc

1. 创建部署目录和 docker-compose.yml 文件 📁

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
mkdir -p /mnt/mydisk/home/mindoc && cd $_ && \
cat > docker-compose.yml <<'EOF'
services:
   mindoc:
      image: ywsj/mindoc:latest
      container_name: mindoc
      privileged: false
      restart: always
      ports:
         - 8181:8181
      volumes:
         - ./mindoc/conf://mindoc/conf
         - ./mindoc/static://mindoc/static
         - ./mindoc/views://mindoc/views
         - ./mindoc/uploads://mindoc/uploads
         - ./mindoc/runtime://mindoc/runtime
         - ./mindoc/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=true
         - MINDOC_BASE_URL=
         - MINDOC_CDN_IMG_URL=
         - MINDOC_CDN_CSS_URL=
         - MINDOC_CDN_JS_URL=
      dns:
         - 223.5.5.5
         - 223.6.6.6
EOF

2. 拉取镜像并启动容器 🚀

1
docker-compose up -d

🚀 二、使用 MinDoc

1. 访问 Web 界面 💻

2. 首次使用步骤 🎯

  1. 打开浏览器访问上述地址
  2. 使用默认账号密码登录（admin/123456）
  3. 创建项目 → 添加文档 → 开始管理文档！

🌐 三、Nginx 反向代理配置

访问地址示例：https://mindoc.example.com

1. 创建 Nginx 配置文件 🔧

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
mkdir -p /etc/nginx/conf.d && \
cat > /etc/nginx/conf.d/mindoc.conf <<'EOF'
server {
    listen 80;
    listen [::]:80;
    server_name mindoc.example.com;   # 替换为你的域名

    # 重定向到 HTTPS
    return 301 https://$server_name$request_uri;
}

server {
    listen 443 ssl http2;
    listen [::]:443 ssl http2;
    server_name mindoc.example.com;   # 替换为你的域名

    # SSL 证书
    ssl_certificate /etc/nginx/ssl/cert.pem;
    ssl_certificate_key /etc/nginx/ssl/key.pem;
    ssl_protocols TLSv1.2 TLSv1.3;
    ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384;
    ssl_prefer_server_ciphers off;

    # 安全头部
    add_header X-Frame-Options SAMEORIGIN;
    add_header X-Content-Type-Options nosniff;
    add_header X-XSS-Protection "1; mode=block";

    # 文件大小限制
    client_max_body_size 100M;

    location / {
        proxy_pass http://127.0.0.1:8181;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_http_version 1.1;
        proxy_buffering off;
    }

    # 错误页
    error_page 500 502 503 504 /50x.html;
    location = /50x.html {
        root /usr/share/nginx/html;
    }
}
EOF

2. 测试并重载 Nginx 🔄

1
sudo nginx -t && sudo systemctl reload nginx

🔧 四、容器维护命令

1. Docker Compose 命令 🐳

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# 进入项目目录（请替换为您的实际目录）
cd /path/to/your/project

# 停止并删除容器
docker-compose down

# 拉取最新镜像
docker-compose pull

# 启动容器
docker-compose up -d

# 仅启动指定服务（请替换 <service_name> 为实际服务名）
docker-compose up -d <service_name>

# 查看服务状态
docker-compose ps

# 查看服务日志
docker-compose logs

# 跟踪服务日志
docker-compose logs -f

# 查看指定服务日志（请替换 <service_name> 为实际服务名）
docker-compose logs <service_name>

# 完整升级流程
docker-compose down && \
docker-compose pull && \
docker-compose up -d && \
docker image prune -f

2. Docker 容器命令 📦

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# 查看所有容器名称
docker ps -a --format "{{.Names}}"

# 查看运行中容器
docker ps

# 停止/启动/重启容器（请替换 <container_name> 为实际容器名）
docker stop <container_name>      # 停止容器
docker start <container_name>     # 启动容器  
docker restart <container_name>   # 重启容器

# 删除容器
docker rm <container_name>        # 删除已停止容器
docker rm -f <container_name>     # 强制删除运行中容器

# 进入容器Shell
docker exec -it <container_name> sh      # 使用sh进入容器
docker exec -it <container_name> bash    # 使用bash进入容器

# 以root身份进入容器  
docker exec -u 0 -it <container_name> sh

# 在容器中执行命令
docker exec <container_name> ls -la

# 查看容器详情和资源使用
docker inspect <container_name>     # 查看详细配置
docker stats <container_name>       # 实时资源监控

## 容器日志管理
docker logs <container_name>           # 查看日志
docker logs -f <container_name>        # 实时跟踪日志
docker logs --tail 100 <container_name>  # 查看最后100行
docker logs -t <container_name>        # 带时间戳的日志

3. Docker 镜像管理 📀

1
2
3
4
docker images                  # 列出所有镜像
docker rmi <image_name:tag>    # 删除指定镜像（请替换为实际镜像名和标签）
docker image prune -f          # 清理悬空镜像
docker image prune -a -f       # 清理所有未使用镜像

🌟 启航知识，探索无限

通过本文档，您已经成功使用 Docker 部署了 MinDoc 文档管理系统，并配置了 Nginx 反向代理实现安全访问。现在您可以：

✨ 集中管理团队文档，告别文档分散和版本混乱的问题
👥 实现高效协作，团队成员可以共同编辑和维护项目文档
📚 构建知识库体系，将零散的知识点系统化整理归档
🔐 精细权限控制，确保不同成员只能访问授权内容

MinDoc 将成为您团队的知识中枢，帮助团队沉淀宝贵经验，提升协作效率。开始构建您团队的专业文档库吧！🏆

📝 重要提示：

  • 首次登录后请立即修改默认密码（admin/123456）以确保安全

  • 建议定期备份 ./mindoc/database 目录下的数据库文件

  • 关注 MinDoc GitHub 项目 获取最新更新和安全公告

祝您使用愉快！🎉