前言

本教程基于飞牛系统fnOS 0.8.41的Docker Compose功能进行搭建。

简介

ShowDoc 是一款国产开源技术文档协作工具，专注于解决研发团队的文档管理难题，尤其在API文档、数据字典、项目协作等领域表现突出，截至2025年3月已在GitHub获得超12.3万Star。

核心功能

  • 多模式文档编写：

    • Markdown编辑器：支持实时预览与扩展语法，满足开发者高效编写需求。

    • 富文本编辑器：为非技术人员提供可视化编辑界面。

    • API文档专属模式：自动生成参数表格，内置接口测试工具，支持Swagger一键导入。

  • 自动化生成文档：

    • 从代码注释自动生成API文档，或通过RunApi客户端（类似Postman）实时调试并生成文档。

  • 团队协作与权限管理：

    • 支持多人实时协作编辑，历史版本回溯与差异对比。

    • 细粒度权限控制，可设置项目级、页面级读写权限。

  • 多场景文档管理：

    • 支持API文档、数据字典、在线表格等多种类型，可导入/导出Word、Markdown等格式。

应用场景

  • API文档管理：结合自动化生成与调试工具，提升前后端协作效率。

  • 数据字典维护：直接从数据库生成表结构文档。

  • 团队知识库：通过项目空间隔离不同团队文档，支持跨平台客户端（Windows/macOS/iOS/Android）访问。

安全与性能

  • 安全风险：旧版本曾存在SQL注入和Phar反序列化漏洞（如3.2.4及更早版本），建议升级至3.2.6及以上版本并启用SFTP/HTTPS协议。

  • 技术架构：采用Vue.js（前端）+ PHP/Laravel（后端）+ MySQL/Redis（数据层），支持Elasticsearch增强搜索性能。

部署

  1. 打开Docker管理器，选择「Compose」，点击右上角「新增项目」。

  2. 在创建项目窗口中填写「项目名称」和选择数据存放「路径」，然后选择「创建docker-compose.yml」，将下列代码根据自己实际情况修改后复制粘贴进去。

    
version: '3.8'  # 兼容最新Compose语法
services:
  showdoc:
    image: star7th/showdoc:latest  # 使用官方最新镜像
    container_name: show-doc
    restart: always  # 重启策略
    ports:
      - "4999:80"  # 默认端口映射
    volumes:
      - ./data/html:/var/www/html  # 持久化文档数据
      - ./data/showdoc_data:/showdoc_data_old  # 历史数据兼容目录
    environment:
      TZ: Asia/Shanghai  # 时区设置

    勾选「创建项目后立即启动」，最后点击「确定」。

  3. 等待构建完成，然后在浏览器中输入IP:Port​访问。

使用

请参照官方文档 Show Doc（https://www.showdoc.com.cn/help）