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如同不反对批改，xiaoz未找到批改的中央，如果你发现了，欢送留言通知我。

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
此文章首发于我的独立博客：https://blog.xiaoz.org/archives/18735