ShowDoc 是一个非常适合 IT 团队的在线 API 文档和技术文档工具。通过 ShowDoc，可以方便地使用 Markdown 语法书写美观的 API 文档、数据字典、技术文档、在线 Excel 文档等。

ShowDoc 提供了在线版本，可以直接注册并使用：https://www.showdoc.com.cn/。如果团队需要使用私有部署，本文将分享如何使用 Docker 来部署 ShowDoc。

Docker 部署 ShowDoc

Docker 部署 ShowDoc 非常简单，只需执行以下命令：

docker run -d --name showdoc --user=root --privileged=true -p 4999:80 \
-v /showdoc_data/html:/var/www/html/ star7th/showdoc

• 4999：访问端口，可自行修改
• /showdoc_data/html：数据存放目录，可自行修改

部署成功后，通过 http://IP:4999 访问，初始账户密码是 showdoc/123456。

目前管理员账户名 showdoc 不支持修改。

Docker Compose 部署

如果选择使用 Docker Compose 部署，需要先创建一个 docker-compose.yaml 文件，内容如下：

version: '3.3'
services:
    showdoc:
        container_name: showdoc
        privileged: true
        ports:
            - '4999:80'
        volumes:
            - './data:/var/www/html/'
        image: star7th/showdoc

然后输入命令启动：docker-compose up -d。部署成功后，通过 http://IP:4999 访问，初始账户密码是 showdoc/123456。

通过绑定域名访问

Docker 部署后默认使用 http://IP:4999 访问。如果需要使用域名访问，可以通过 Nginx 反向代理来实现。以下是一个 Nginx 反向代理的配置示例：

server {
    listen       80;
    server_name  test.showdoc.com.cn;
    client_max_body_size 1000m;
    location ^~ / {
        proxy_pass http://127.0.0.1:4999/;
        proxy_redirect off;
        proxy_connect_timeout 90;
        proxy_send_timeout 90;
        proxy_read_timeout 90;
        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 http_user_agent $http_user_agent;
    }
}

部分截图

ShowDoc 界面非常简洁，以下是几张截图：

结语

ShowDoc 文档系统非常简洁，适合初创公司或小团队使用。此外，使用 Docker 部署 ShowDoc 也非常简单。如果您正在寻找一款开源的文档系统，建议试试 ShowDoc。

• ShowDoc 帮助文档：https://www.showdoc.com.cn/help/1385767280275683
• Github 开源地址：https://github.com/star7th/showdoc