开源ShowDoc文档管理平台容器化部署

作者：UStarGao 日期：2021-09-07 13:10:38 人气：栏目：开源方案

一、ShowDoc是什么

ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具。通过showdoc，你可以方便地使用markdown语法来书写出美观的API文档、数据字典文档、技术文档、在线excel文档等等。如果不想编辑markdown文档，你还可以利用showdoc的自动化能力，从程序注释中自动生成API文档，或者从搭配的RunApi客户端（类似postman的api调试工具）中一边调试接口、一边自动生成文档。通过分配项目成员和团队成员，你可以很方便地进行项目文档的权限管理和团队协作，也可以分享文档出去给朋友查看。ShowDoc还支持多平台客户端，有win客户端、mac客户端、ios、android等，更方便跨平台使用。

官网介绍文档：https://www.showdoc.com.cn/help/1385767280275683

二、容器化部署ShowDoc

2.1 Docker镜像拉取

[root@blogs-v2 ~]# docker pull star7th/showdoc

2.2 新建持久化目录

[root@blogs-v2 ~]# mkdir -p /data/showdoc_data/html
[root@blogs-v2 ~]# chmod  -R 777 /data/showdoc_data

2.3 运行容器

[root@blogs-v2 ~]# docker run -d --name showdoc --restart=always --user=root --privileged=true -p 8080:80 -v /data/showdoc_data/html:/var/www/html/ star7th/showdoc

2.4 Nginx代理配置

[root@ansible ~]# vim /etc/nginx/conf.d/showdoc.starcto.com.conf
server {
   listen 80;
   listen [::]:80;
   server_name showdoc.starcto.com;
   rewrite ^ https://$http_host$request_uri? permanent;
}

server {
   listen       443 ssl http2 ;
   listen       [::]:443 ssl http2;
   server_name  showdoc.starcto.com;

   ssl_certificate "/data/ssl/showdoc.starcto.com/public.pem";
   ssl_certificate_key "/data/ssl/showdoc.starcto.com/private.key";
   ssl_session_cache shared:SSL:1m;
   ssl_session_timeout  10m;
   ssl_ciphers HIGH:!aNULL:!MD5;
   ssl_prefer_server_ciphers on;

   location / {
   proxy_pass        http://10.25.203.134:8080;
         proxy_set_header   Host             $host;
         proxy_set_header   X-Real-IP        $remote_addr;
         proxy_set_header   X-Forwarded-For  $proxy_add_x_forwarded_for;
   }
}
[root@ansible ~]# systemctl restart nginx.service

2.5 WEB访问配置

https://showdoc.starcto.com/

容器化部署ShowDoc文档管理平台(图1)