Docker安裝showdoc

1、簡介

ShowDoc是什麼

• 每當接手一個他人開發好的模塊或者項目，看着那些沒有寫註釋的代碼，咱們都無比抓狂。文檔呢？！文檔呢？！Show me the doc ！！

• 程序員都很但願別人能寫技術文檔，而本身卻很不但願要寫文檔。由於寫文檔須要花大量的時間去處理格式排版，想着新建的word文檔放在哪一個目錄等各類非技術細節。

• word文檔零零散散地放在團隊不一樣人那裏，須要文檔的人基本靠吼，吼一聲而後上qq或者郵箱接收對方丟過來的文檔。這種溝通方式固然能夠，只是效率不高。

• ShowDoc就是一個很是適合IT團隊的在線文檔分享工具，它能夠加快團隊之間溝通的效率。

它能夠用來作什麼

• API文檔（ 查看Demo）

  • 隨着移動互聯網的發展，BaaS（後端即服務）愈來愈流行。服務端提供API，APP端或者網頁前端即可方便調用數據。用ShowDoc能夠很是方便快速地編寫出美觀的API文檔。

• 數據字典（ 查看Demo）

  • 一份好的數據字典能夠很方便地向別人說明你的數據庫結構，如各個字段的釋義等。

• 說明文檔 （ 查看Demo）

  • 你徹底可使用showdoc來編寫一些工具的說明書,也能夠編寫一些技術規範說明文檔以供團隊查閱

 

2、安裝

環境說明

操做系統：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"; } }

 

訪問頁面

選擇中文

點擊進入網站首頁

用戶名：showdoc

密碼：123456

 

點擊管理後臺，修改密碼

 

本文參考連接：

https://www.showdoc.cc/help?page_id=65610