准備 Nginx + PHP 環境
安裝 Nginx
使用 yum 安裝 Nginx：
yum -y install epel-release yum -y install nginx
修改 /etc/nginx/nginx.conf 文件：
... ...
http
{
... ...
server {
... ...
root /var/www/html; # 網站根目錄
index index.php index.html; # 默認索引項
error_page 404 /404.html;
location = /40x.html {
}
error_page 500 502 503 504 /50x.html;
location = /50x.html {
}
location ~ .php$ {
root /var/www/html;
fastcgi_pass 127.0.0.1:9000;
fastcgi_index index.php;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
include fastcgi_params;
}
location ~ /.ht {
deny all;
}
}
}
啟動 Nginx 並設置為開機啟動：
systemctl start nginx systemctl enable nginx
安裝 PHP
使用 yum 安裝 php-fpm：
yum -y install php php-gd php-fpm php-mcrypt php-mbstring php-mysql php-pdo
啟動 php-fpm 並設置為開機啟動：
systemctl start php-fpm systemctl enable php-fpm
創建項目
下載安裝 Composer
Composer 是 PHP 的一個依賴管理工具，推薦使用 Composer 創建 ShowDoc 項目。
執行如下命令安裝 Composer：
curl -sS https://getcomposer.org/installer | phpmv composer.phar /usr/local/bin/composer
安裝過程可能需要耗費幾分鍾
設置 Composer 使用國內鏡像
執行命令設置 Composer 使用國內鏡像：
composer config -g repo.packagist composer https://packagist.phpcomposer.com
為了避免訪問國外網絡導致的延遲，推薦使用國內鏡像源
使用 Composer 創建項目
執行命令創建項目：
cd /var/www/html && composer create-project showdoc/showdoc
設置 showdoc 目錄寫權限
執行命令賦予 showdoc 下部分目錄的寫權限
chmod a+w showdoc/install
chmod a+w showdoc/Sqlite
chmod a+w showdoc/Sqlite/showdoc.db.php
chmod a+w showdoc/Public/Uploads/
chmod a+w showdoc/Application/Runtime
chmod a+w showdoc/server/Application/Runtime
chmod a+w showdoc/Application/Common/Conf/config.php
chmod a+w showdoc/Application/Home/Conf/config.php
創建完畢，您現在可以通過瀏覽器訪問 http://<您的 CVM IP 地址>/showdoc/install/ ，進行語言的選擇以后即可通過 http://<您的 CVM IP 地址>/showdoc 查看站點效果。
關閉SELinux
1、臨時關閉
setenforce 0
2、永久關閉
vim /etc/selinux/config
修改為以下內容
SELINUX=enforcing
自動生成數據字典
介紹
好的數據字典文檔能夠清晰地反映出數據庫的結構以及相關釋義，方便技術人員查閱。我們很容易使用showdoc來生成展示數據庫結構的字典文檔，並且能根據數據庫結構的變動來自動修改文檔，省去人工編輯的麻煩。
這一切的自動化依賴於我們的上報腳本。你需要下載我們的腳本到你的服務器上執行，上傳數據庫結構信息到showdoc。上報腳本的源碼完全公開，你可以閱讀之以確認安全。我們確保它只會上傳基本數據庫結構信息，不會上傳數據庫密碼配置、業務數據等敏感信息。
目前只支持linux下的mysql數據庫，更多類型未來再考慮。
操作步驟
l 執行下載腳本的命令
a) wget https://www.showdoc.cc/script/showdoc_db.sh
l 打開此文件
b) vi showdoc_db.sh
l 修改配置信息
打開文件后，在文件的前面能看到幾項配置。其中，像數據庫配置、api_key等信息是需要你填寫的，填寫完畢后保存即可。下面用表格的形式列舉出各個配置項代表的意思。
| 項目 |
解釋 |
| host |
數據庫所在地址。默認是localhost |
| port |
數據庫訪問端口，默認是3306 |
| user |
數據庫用戶名 |
| password |
密碼 |
| db |
要同步的數據庫名。要同步多個db可以將本腳本復制多份 |
| api_key |
api_key，認證憑證。登錄showdoc，創建一個項目后，點擊右上角的”項目設置”-“開放API”便可看到 |
| api_token |
同上 |
| cat_name |
可選。如果想把生成的文檔都放在項目的子目錄下，則這里填寫子目錄名。 |
| url |
可選。同步到的url。如果是使用www.showdoc.cc ，則不需要再改此項。如果是部署開源版showdoc，請改此項為http://xx.com/server/index.php?s=/api/open/updateDbItem 。其中xx.com為你的部署域名 |
l 執行
c) chmod +x showdoc_db.sh
d) ./showdoc_db.sh
看到成功字樣便ok。你可以打開showdoc項目看看是否真的生成了。
l 定時自動更新
如果想定時自動更新，則需要為系統增加一個定時任務。下面給一個例子，表示每10分鍾同步一次
e) /10 * * * * /root/showdoc_db.sh
其中，showdoc_db.sh腳本在定時任務里需要寫絕對路徑。
注意事項
如果你設置了腳本的自動執行，那么請不要再手動登錄showdoc修改文檔。因為你的修改都會被自動腳本重新覆蓋。
因為會覆蓋你的修改，所以如果你想為某個字段設置中文注釋，請修改mysql字段注釋，而不是在showdoc上手動編輯文檔。
自動執行的情況下，只會自動新增和修改文檔，不會自動刪除文檔（主要出於數據安全考慮）。所以，如果你刪除了一張表，文檔里是不會刪除那個頁面的。需要手動登錄showdoc來刪除。一般來講，這種情況不會很多。