1. 摘要
本文提供了將PlantUML與GitLab集成的逐步指南。它涵蓋了從配置PlantUML服務(wù)器到在GitLab中啟用它的所有內(nèi)容霹抛，并包括代碼塊以說明必要的命令糖驴。通過遵循本指南村砂，您將能夠使用PlantUML在GitLab snips蕊连、wikis和代碼庫(kù)中創(chuàng)建圖表决记。
2. 前言
當(dāng)在GitLab集成并正確配置PlantUML后某弦，您可以在snip桐愉、Wiki和代碼庫(kù)中創(chuàng)建圖表危纫。此GitLab.com上PlantUML默認(rèn)為所有SaaS用戶啟用宗挥，不需要任何額外配置。
要在自管理實(shí)例上設(shè)置PlantUML种蝶，必須：
- 配置PlantUML服務(wù)器契耿。
- 配置本地PlantUML訪問。
- 配置PlantUML安全性螃征。
- 啟用PlantUML搪桂。
3. 配置PlantUML服務(wù)器
如果你的服務(wù)器是debian或ubuntu系列, 可以使用源碼安裝plantuml server. 如果是其他類型的服務(wù)器, 建議使用docker安裝plantuml server.
本教程主要講解docker啟動(dòng)plantuml server.
使用下面的命令即可快速啟動(dòng)一個(gè)plantuml server容器.
docker run -d --name plantuml -p 8080:8080 -e PLANTUML_LIMIT_SIZE=8192m -e PLANTUML_FONT_PATH=/usr/share/fonts/truetype/dejavu/ plantuml/plantuml-server:tomcat
確認(rèn)容器啟動(dòng)沒有問題后, 將容器設(shè)置為開機(jī)自啟.
docker update --restart=always plantuml
如果你的gitlab服務(wù)器本身就是使用docker-compose啟動(dòng)的, 那么可以在docker-compose的配置文件中, 可以參考下面配置添加plantuml-server
version: "3"
services:
gitlab:
image: 'gitlab/gitlab-ee:12.2.5-ee.0'
environment:
GITLAB_OMNIBUS_CONFIG: |
nginx['custom_gitlab_server_config'] = "location /-/plantuml/ { \n proxy_cache off; \n proxy_pass http://plantuml:8080/; \n}\n"
plantuml:
image: 'plantuml/plantuml-server:tomcat'
container_name: plantuml
4. 配置本地PlantUML訪問
PlantUML服務(wù)器在您的服務(wù)器上運(yùn)行，因此默認(rèn)情況下無法從外部訪問盯滚。您的服務(wù)器必須捕獲PlantUML調(diào)用gitlab請(qǐng)求https://gitlab.example.com/-/plantuml/并將它們重定向到PlantUML服務(wù)器踢械。根據(jù)您的設(shè)置，URL為以下任一項(xiàng):
http://plantuml:8080/
http://localhost:8080/
如果使用安全協(xié)議TLS運(yùn)行GitLab魄藕，則必須配置此重定向内列，因?yàn)镻lantUML使用不安全的HTTP協(xié)議。較新的瀏覽器（如Google Chrome 86+）不會(huì)在通過HTTPS提供的頁(yè)面上加載不安全的HTTP資源背率。所以需要添加額外的配置.
要啟用此重定向话瞧，請(qǐng)執(zhí)行以下操作：
根據(jù)您的設(shè)置方法，在/etc/gitlab/gitlab.rb中添加以下行：
# Docker deployment
nginx['custom_gitlab_server_config'] = "location /-/plantuml/ { \n proxy_cache off; \n proxy_pass http://localhost:8080/; \n}\n"
要激活更改寝姿，請(qǐng)運(yùn)行以下命令：
sudo gitlab-ctl reconfigure
重啟gitlab
sudo gitlab-ctl restart
5. 開啟 PlantUML
啟動(dòng)完成后移稳，需要在 GitLab 上配置開啟 PlantUML，管理員登錄 -> Admin Area -> Settings会油，復(fù)選框選中 Enable PlantUML个粱，輸入 PlantUML URL（就是剛剛啟動(dòng)的 PlantUML Server 服務(wù)監(jiān)聽地址）例如:http://your_plantuml_server_host:8080。好了現(xiàn)在可以開始 PlantUML 之旅了翻翩。
