体验 私有化部署showDoc

ShowDoc介绍

ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具。通过showdoc，你可以方便地使用markdown语法来书写出美观的API文档、数据字典文档、技术文档、在线excel文档等等。如果不想编辑markdown文档，你还可以利用showdoc的自动化能力，从程序注释中自动生成API文档，或者从搭配的RunApi客户端（类似postman的api调试工具）中一边调试接口、一边自动生成文档。通过分配项目成员和团队成员，你可以很方便地进行项目文档的权限管理和团队协作，也可以分享文档出去给朋友查看。ShowDoc还支持多平台客户端，有win客户端、mac客户端、ios、android等，更方便跨平台使用。目前超过100000+的互联网团队正在使用showdoc，包括知名公司内部的一些团队，比如腾讯、华为、百度、京东、字节跳动等等。 关于ShowDoc的更多介绍，请访问：www.showdoc.com.cn/help

自动脚本安装

官方强烈推荐使用自动脚本安装showdoc，你只需要在命令行下执行命令即可。自动脚本安装教程：www.showdoc.com.cn/help?page_i… 。

配置域名及nginx代理

• 自动安装脚本安装完以后 showdoc默认运行在4999端口
• 然后我们配置域名用nginx代理到4999端口即可 nginx配置如下

 server {
        listen       80;
        server_name doc.tecqm.cn doc.fshuison.cn doc.qinkeji.cn;
        location / {
            proxy_pass http://localhost:4999;
            proxy_redirect  off;
            proxy_set_header Host $host;
            proxy_set_header X-Real-IP $remote_addr;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
         }
     }

• 然后访问域名即可使用 不受限制的showdoc