Docker安装showdoc

我就是我 2023-06-25 10:12 3阅读 0赞

# 一、简介 #

#### ShowDoc是什么 ####

*  每当接手一个他人开发好的模块或者项目，看着那些没有写注释的代码，我们都无比抓狂。文档呢？！文档呢？！Show me the doc ！！
 *  程序员都很希望别人能写技术文档，而自己却很不希望要写文档。因为写文档需要花大量的时间去处理格式排版，想着新建的word文档放在哪个目录等各种非技术细节。
 *  word文档零零散散地放在团队不同人那里，需要文档的人基本靠吼，吼一声然后上qq或者邮箱接收对方丢过来的文档。这种沟通方式当然可以，只是效率不高。
 *  ShowDoc就是一个非常适合IT团队的在线文档分享工具，它可以加快团队之间沟通的效率。

#### 它可以用来做什么 ####

*  ##### API文档（ [查看Demo][Demo]） #####
    
     *  随着移动互联网的发展，BaaS（后端即服务）越来越流行。服务端提供API，APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档。
 *  ##### 数据字典（ [查看Demo][Demo 1]） #####
    
     *  一份好的数据字典可以很方便地向别人说明你的数据库结构，如各个字段的释义等。
 *  ##### 说明文档 （ [查看Demo][Demo 2]） #####
    
     *  你完全可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅

# 二、安装 #

## 环境说明 ##

操作系统：centos 7.6

docker版本：19.03.5

ip地址：192.168.31.150

## 下载镜像 ##

docker pull star7th/showdoc

创建目录

mkdir -p /data/showdoc_data/html
    chmod  -R 777 /data/showdoc_data

## 启动showdoc容器 ##

docker run -d --restart=always  --name showdoc -p 4999:80 -v /data/showdoc_data/html:/var/www/html/  star7th/showdoc

直接使用ip地址+4999就可以访问了，但是在公司里面，一般使用域名访问。所以还需要用到nginx

## 使用Nginx发布 ##

添加配置文件

vi /etc/nginx/conf.d/vhosts/wiki.conf

内容如下：

upstream showdoc {
        server 127.0.0.1:4999  max_fails=2 fail_timeout=1;
    }
    
    server {
     listen 80;
     server_name wiki.xx.com;
     access_log logs/nginx/wiki.xx.com.access.log main;
     error_log logs/wiki.xx.com.error.log;
    
       location / {
       proxy_pass http://showdoc;
            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_connect_timeout 300s;
            proxy_send_timeout 300s;
            proxy_read_timeout 300s; 
            # websocket support
            proxy_http_version 1.1;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection "upgrade";
        }   
    }

## 访问页面 ##

选择中文

![1341090-20191227161304924-1866341847.png][]

点击进入网站首页

![1341090-20191227161311158-2039420956.png][]

用户名：showdoc

密码：123456

![1341090-20191227161334065-738286312.png][]

点击管理后台，修改密码

![1341090-20191227161412670-2096496972.png][]

本文参考链接：

[https://www.showdoc.cc/help?page\_id=65610][https_www.showdoc.cc_help_page_id_65610]

[Demo]: http://www.showdoc.cc/2
[Demo 1]: http://www.showdoc.cc/1
[Demo 2]: http://www.showdoc.cc/3
[1341090-20191227161304924-1866341847.png]: https://img2018.cnblogs.com/common/1341090/201912/1341090-20191227161304924-1866341847.png
[1341090-20191227161311158-2039420956.png]: https://img2018.cnblogs.com/common/1341090/201912/1341090-20191227161311158-2039420956.png
[1341090-20191227161334065-738286312.png]: https://img2018.cnblogs.com/common/1341090/201912/1341090-20191227161334065-738286312.png
[1341090-20191227161412670-2096496972.png]: https://img2018.cnblogs.com/common/1341090/201912/1341090-20191227161412670-2096496972.png
[https_www.showdoc.cc_help_page_id_65610]: https://www.showdoc.cc/help?page_id=65610