Flexus X 實(shí)例安裝 ShowDoc 文檔管理工具

引言

在數(shù)字化的時(shí)代浪潮中，華為云以其強(qiáng)大的實(shí)力和卓越的性能，為企業(yè)和開(kāi)發(fā)者提供了堅(jiān)實(shí)的技術(shù)支撐。而 Flexus 云服務(wù)器 X 實(shí)例，更是展現(xiàn)了華為云的創(chuàng)新與優(yōu)秀，此次我們將在其上安裝 ShowDoc 文檔管理工具，開(kāi)啟高效協(xié)作之旅。

一、Flexus 云服務(wù)器 X 實(shí)例介紹

1.1 Flexus 云服務(wù)器 X 實(shí)例簡(jiǎn)介

華為云 Flexus 云服務(wù)器 X 實(shí)例官網(wǎng)：Flexus云服務(wù)器X實(shí)例

華為云 Flexus 云服務(wù)器 X 實(shí)例屬于新一代云服務(wù)器，專為中小企業(yè)和開(kāi)發(fā)者打造，具備柔性算力。它能夠智能感知業(yè)務(wù)負(fù)載，適用于電商直播、企業(yè)建站、開(kāi)發(fā)測(cè)試環(huán)境、游戲服務(wù)器、音視頻服務(wù)等中低負(fù)載場(chǎng)景。與 Flexus 應(yīng)用服務(wù)器 L 實(shí)例相比，F(xiàn)lexus 云服務(wù)器 X 實(shí)例具有諸多優(yōu)勢(shì)，例如提供豐富的公共鏡像、可靈活自定義 vCPU 內(nèi)存配比、能智能感知業(yè)務(wù)動(dòng)態(tài)升降配，而且負(fù)載范圍更高等。

1.2 主要使用場(chǎng)景

·電商直播在電商直播領(lǐng)域，F(xiàn)lexus 云服務(wù)器 X 實(shí)例展現(xiàn)出卓越的適應(yīng)性。隨著電商市場(chǎng)的動(dòng)態(tài)變化，業(yè)務(wù)壓力時(shí)刻處于波動(dòng)之中。利用 Flexus X 實(shí)例搭建電商交易平臺(tái)，能夠游刃有余地應(yīng)對(duì)這種變化。無(wú)論是促銷(xiāo)活動(dòng)期間流量的爆發(fā)式增長(zhǎng)，還是日常運(yùn)營(yíng)中的業(yè)務(wù)壓力起伏，該實(shí)例憑借其獨(dú)特的性能優(yōu)勢(shì)，確保電商平臺(tái)的穩(wěn)定運(yùn)行，為商家和消費(fèi)者提供可靠的交易環(huán)境。

·企業(yè)建站對(duì)于企業(yè)建站需求，無(wú)論是創(chuàng)建博客、搭建論壇，還是構(gòu)建企業(yè)門(mén)戶等業(yè)務(wù)場(chǎng)景，F(xiàn)lexus 云服務(wù)器 X 實(shí)例都能發(fā)揮重要作用。它有助于企業(yè)有效地傳播自身的價(jià)值信息，推動(dòng)信息在企業(yè)內(nèi)部、企業(yè)與客戶之間的共享和交流。企業(yè)可以借助這一實(shí)例輕松搭建多功能的傳播和交互平臺(tái)，全方位展示企業(yè)形象、產(chǎn)品信息以及服務(wù)內(nèi)容，從而增強(qiáng)企業(yè)的品牌影響力和用戶粘性。

·個(gè)人開(kāi)發(fā)測(cè)試在個(gè)人開(kāi)發(fā)和測(cè)試方面，開(kāi)發(fā)者常常需要各種各樣的環(huán)境資源。Flexus 云服務(wù)器 X 實(shí)例為開(kāi)發(fā)者提供了便捷且經(jīng)濟(jì)高效的解決方案。選擇從云上獲取所需資源，基于該實(shí)例搭建開(kāi)發(fā)測(cè)試環(huán)境，能夠讓開(kāi)發(fā)者更加專注于代碼編寫(xiě)和功能測(cè)試。與傳統(tǒng)方式相比，這種方式不僅操作更加便利，而且在成本控制上更具優(yōu)勢(shì)，有助于提高開(kāi)發(fā)效率，縮短項(xiàng)目周期。

·游戲服務(wù)器 Flexus 云服務(wù)器 X 實(shí)例非常適用于搭建游戲后臺(tái)服務(wù)器。在游戲運(yùn)營(yíng)過(guò)程中，它強(qiáng)大的算力足以輕松應(yīng)對(duì)數(shù)千人同時(shí)在線的復(fù)雜情況。當(dāng)服務(wù)器玩家數(shù)量出現(xiàn)上漲趨勢(shì)時(shí)，該實(shí)例的平滑擴(kuò)容能力能夠迅速響應(yīng)，確保游戲的流暢性和穩(wěn)定性。此外，其超強(qiáng)的網(wǎng)絡(luò)加速能力顯著提升了玩家的游戲體驗(yàn)，減少延遲、卡頓等現(xiàn)象，為游戲的成功運(yùn)營(yíng)提供了堅(jiān)實(shí)的技術(shù)保障。

二、購(gòu)買(mǎi) Flexus 云服務(wù)器 X 實(shí)例

2.1 購(gòu)買(mǎi)規(guī)格參考

·華為云 Flexus X 實(shí)例的購(gòu)買(mǎi)規(guī)格可以參考如下所示：

·可參考以下配置詳情頁(yè)，確認(rèn)無(wú)誤后，勾選“協(xié)議許可”，點(diǎn)擊立即購(gòu)買(mǎi)。

2.2 查看 Flexus 云服務(wù)器 X 實(shí)例狀態(tài)

購(gòu)買(mǎi)成功后，進(jìn)入到 Flexus 云服務(wù)器 X 實(shí)例控制臺(tái)，可以看到 Flexus X 實(shí)例已經(jīng)正常運(yùn)行中。

三、遠(yuǎn)程連接 Flexus 云服務(wù)器 X 實(shí)例

3.1 重置密碼

選擇“重置密碼”選項(xiàng)，重置 Flexus 云服務(wù)器 X 實(shí)例的登錄密碼。

登錄密碼自定義設(shè)置，勾選自動(dòng)重啟選項(xiàng)，確認(rèn)。

3.2 本地 MobaXterm 工具遠(yuǎn)程連接

可以使用本地 MobaXterm 工具連接 Flexus 云服務(wù)器 X 實(shí)例，填寫(xiě) Flexus 云服務(wù)器 X 實(shí)例的彈性公網(wǎng) IP 地址后，在終端界面填寫(xiě) root 賬號(hào)和密碼即可遠(yuǎn)程連接。

四、部署 ShowDoc 應(yīng)用

4.1ShowDoc 介紹

簡(jiǎn)介：

ShowDoc 是一款專為 API 文檔管理設(shè)計(jì)的工具，支持在線協(xié)作編輯，能夠幫助團(tuán)隊(duì)更高效地管理和分享接口文檔。

特點(diǎn)：

·實(shí)時(shí)協(xié)作：團(tuán)隊(duì)成員可以同時(shí)編輯同一份文檔，提高工作效率。

·版本控制：保留文檔的歷史版本，方便回溯查看或恢復(fù)。

·權(quán)限管理：可設(shè)置文檔訪問(wèn)權(quán)限，保護(hù)文檔安全。

·插件擴(kuò)展：支持多種插件以增強(qiáng)功能，滿足不同需求。

·多平臺(tái)支持：可在多種操作系統(tǒng)上運(yùn)行，并提供 Web 界面訪問(wèn)。

·自定義樣式：允許用戶定制文檔樣式，符合品牌形象或個(gè)人偏好。

·離線訪問(wèn)：部分功能支持在沒(méi)有網(wǎng)絡(luò)的情況下使用，增加靈活性。

主要使用場(chǎng)景：

1.軟件開(kāi)發(fā)團(tuán)隊(duì)：用于記錄和維護(hù) API 接口文檔。

2.產(chǎn)品與技術(shù)對(duì)接：作為產(chǎn)品和技術(shù)部門(mén)之間溝通的技術(shù)文檔工具。

3.遠(yuǎn)程協(xié)作項(xiàng)目：支持分布式團(tuán)隊(duì)共享和編輯文檔。

4.內(nèi)部知識(shí)庫(kù)建設(shè)：構(gòu)建企業(yè)內(nèi)部的知識(shí)管理系統(tǒng)。

5.API 測(cè)試輔助：結(jié)合測(cè)試工具進(jìn)行 API 測(cè)試案例記錄與分享。

6.客戶技術(shù)支持：向客戶提供清晰的產(chǎn)品 API 使用指南。

7.代碼文檔化：自動(dòng)或手動(dòng)將代碼注釋轉(zhuǎn)換成文檔。

4.2 實(shí)踐環(huán)境規(guī)劃

4.3 本地環(huán)境檢查

檢查當(dāng)前的操作系統(tǒng)版本

[root@flexusx-e2c8 ~]# cat /etc/os-releaseNAME="Rocky Linux"VERSION="9.0 (Blue Onyx)"ID="rocky"ID_LIKE="rhel centos fedora"VERSION_ID="9.0"PLATFORM_ID="platform:el9"PRETTY_NAME="Rocky Linux 9.0 (Blue Onyx)"ANSI_COLOR="0;32"LOGO="fedora-logo-icon"CPE_NAME="cpe:/o:rocky:rocky:9::baseos"HOME_URL="https://rockylinux.org/"BUG_REPORT_URL="https://bugs.rockylinux.org/"ROCKY_SUPPORT_PRODUCT="Rocky-Linux-9"ROCKY_SUPPORT_PRODUCT_VERSION="9.0"REDHAT_SUPPORT_PRODUCT="Rocky Linux"REDHAT_SUPPORT_PRODUCT_VERSION="9.0"

檢查 Docker 版本，需要提前安裝 Docker 環(huán)境。

[root@flexusx-e2c8 ~]# docker -vDocker version 27.1.1, build 6312585

4.4 創(chuàng)建 ShowDoc 容器

·下載 ShowDoc 鏡像

[root@flexusx-e2c8 ~]# docker pull star7th/showdocUsing default tag: latestlatest: Pulling from star7th/showdocca7dd9ec2225: Pull complete1b78b4fe0ca1: Pull complete9d6040f2a28f: Pull complete0e2e66b89284: Pull complete3b1be5f02bec: Pull complete96243f515dda: Pull completee427679e7c26: Pull complete759eb390abda: Pull complete9820b782a628: Pull completea9e6097c1efa: Pull complete561ed9cfdc11: Pull completeb5ac29f40552: Pull complete9c9b9da49812: Pull completea9d2406d9976: Pull complete3cc36ef8d41c: Pull complete640399d119a6: Pull complete86e58e6128a5: Pull completeb0e1f147b984: Pull completee6ce4f3778f4: Pull complete211a642ef74b: Pull complete1451b1c61460: Pull completeeb16da146d29: Pull completeDigest: sha256:229d46f98509176467f82bcea49dda283dffcf308e66214caa7e84b5041fcfb4Status: Downloaded newer image for star7th/showdoc:latestdocker.io/star7th/showdoc:latest

·編輯 docker-compose.yaml 文件，內(nèi)容如下：

version: '3'services:showdoc:image: star7th/showdoccontainer_name: showdocrestart: alwaysuser: rootprivileged: trueports:- "5001:80"volumes:- "/docker/showdoc/html:/var/www/html/"deploy: resources:limits:cpus: '1'memory: 2Greservations:cpus: '0.5'memory: 1G

·創(chuàng)建 ShowDoc 容器

docker compose up -d

4.5 查看 ShowDoc 容器

我們可以看到 ShowDoc 容器已經(jīng)正常運(yùn)行，宿主機(jī)映射的訪問(wèn)端口為 5001。

[root@flexusx-e2c8 shodoc]# docker compose psWARN[0000] /docker/shodoc/docker-compose.yaml: the attribute `version` is obsolete, it will be ignored, please remove it to avoid potential confusionNAME IMAGE COMMAND SERVICE CREATED STATUS PORTSshowdoc star7th/showdoc "/entrypoint bash do…" showdoc 40 seconds ago Up 39 seconds 443/tcp, 9000/tcp, 0.0.0.0:5001->80/tcp, :::5001->80/tcp

查看監(jiān)聽(tīng)端口，ShowDoc 服務(wù)端口為 5001。

[root@flexusx-e2c8 shodoc]# netstat -tunlp |grep 5001tcp 0 0 0.0.0.0:5001 0.0.0.0:* LISTEN 1392767/docker-proxtcp6 0 0 :::5001 :::* LISTEN 1392773/docker-prox

五、訪問(wèn) ShowDoc 應(yīng)用

5.1 安全設(shè)置

在安全組規(guī)則管理界面，入方向規(guī)則上放行 5001 端口。

本次安裝的 Rocky Linux 操作系統(tǒng)默認(rèn)沒(méi)有關(guān)閉防火墻，可以參考以下命令，關(guān)閉防火墻。如果不想關(guān)閉防火墻，則需要放行相關(guān)服務(wù)端口。

systemctl stop firewalld && systemctl disable firewalld

關(guān)閉 selinux 服務(wù)

setenforce 0

sed -i 's/SELINUX=enforcing/SELINUX=disabled/' /etc/selinux/config

5.2 訪問(wèn) ShowDoc 服務(wù)

訪問(wèn) ShowDoc 首頁(yè)

在瀏覽器中輸入以下地址：https://公網(wǎng) IP 地址:5001（將"公網(wǎng) IP 地址"替換為你的服務(wù)器的彈性公網(wǎng) IP 地址），輸入設(shè)置的訪問(wèn)口令，進(jìn)入 ShowDoc 筆記首頁(yè)。

可以看到提示的默認(rèn)登錄管理員賬號(hào)和密碼為 showdoc/123456，點(diǎn)擊進(jìn)入首頁(yè)。

在登錄頁(yè)，輸入賬號(hào)密碼后，進(jìn)入 ShowDoc 管理頁(yè)面。

進(jìn)入后臺(tái)管理

如圖所示，進(jìn)入 ShowDoc 后臺(tái)管理頁(yè)面。

新建文檔

·點(diǎn)擊“創(chuàng)建新項(xiàng)目”

·填寫(xiě)項(xiàng)目名稱、項(xiàng)目描述等信息，自行設(shè)置即可。

點(diǎn)擊下方的“+”號(hào)，新建頁(yè)面。

編輯文檔內(nèi)容和標(biāo)題，保存文檔。

·查看文檔效果

分享文檔

點(diǎn)擊分享選項(xiàng)，復(fù)制分享鏈接給其他。

六、總結(jié)與體會(huì)

通過(guò)在華為云 Flexus 云服務(wù)器 X 實(shí)例上安裝 ShowDoc 文檔管理工具，我們深切感受到了華為云的強(qiáng)大實(shí)力。Flexus X 實(shí)例以其卓越的性能和穩(wěn)定性，為團(tuán)隊(duì)協(xié)作提供了可靠的基礎(chǔ)。華為云不斷創(chuàng)新，為中小企業(yè)和開(kāi)發(fā)者帶來(lái)更多優(yōu)秀的解決方案，助力他們?cè)跀?shù)字化時(shí)代乘風(fēng)破浪。

華為云 Flexus 云服務(wù)器 X 實(shí)例?擁有眾多卓越優(yōu)勢(shì)。它如同一個(gè)擁有無(wú)限可能的數(shù)字空間???，提供無(wú)限擴(kuò)展的可能；性能強(qiáng)勁???，穩(wěn)定可靠，資源調(diào)度靈活自如???；更有多重安全防護(hù)措施????，有效滿足各種變動(dòng)需求的同時(shí)，全力保障數(shù)據(jù)安全。

華為云 828 活動(dòng)已盛大開(kāi)啟???，其一鍵式管理功能猶如一把神奇的鑰匙???，極大地簡(jiǎn)化了運(yùn)維工作?，F(xiàn)在，就讓我們一同踏上這場(chǎng)探索數(shù)字化未來(lái)的精彩之旅吧???！

審核編輯 黃宇