華為云 Flexus 云服務(wù)器 X 實(shí)例之 openEuler 系統(tǒng)下部署 CodeX Docs 文檔工具

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

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

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

華為云 Flexus 云服務(wù)器 X 實(shí)例是新一代面向中小企業(yè)和開發(fā)者的柔性算力云服務(wù)器。它能夠智能感知業(yè)務(wù)負(fù)載的變化，自動(dòng)調(diào)整資源配置。這款服務(wù)器特別適用于中低負(fù)載的應(yīng)用場(chǎng)景，例如電商直播、企業(yè)網(wǎng)站建設(shè)、開發(fā)測(cè)試環(huán)境、游戲服務(wù)器以及音視頻服務(wù)等。X 實(shí)例的設(shè)計(jì)理念旨在為用戶提供更加靈活和高效的計(jì)算資源管理方式。通過智能調(diào)整，它可以更好地滿足不同業(yè)務(wù)的需求，提高資源利用率。

1.2 Flexus 云服務(wù)器 X 實(shí)例特點(diǎn)

·提供豐富的公共鏡像：Flexus 云服務(wù)器 X 實(shí)例提供多種公共鏡像供用戶選擇，方便快速部署各種應(yīng)用和服務(wù)。

·可靈活自定義 vCPU 內(nèi)存配比：用戶可以根據(jù)自己的需要靈活調(diào)整虛擬 CPU 和內(nèi)存的配比，以滿足不同場(chǎng)景的需求。

·智能感知業(yè)務(wù)動(dòng)態(tài)升降配：Flexus 云服務(wù)器 X 實(shí)例能夠智能感知業(yè)務(wù)的負(fù)載情況，并根據(jù)需要自動(dòng)升降配，以滿足業(yè)務(wù)的需求，提高系統(tǒng)的穩(wěn)定性和性能。

·負(fù)載范圍更高：相對(duì)于 Flexus 應(yīng)用服務(wù)器 L 實(shí)例，F(xiàn)lexus 云服務(wù)器 X 實(shí)例能夠處理更高的負(fù)載，適用于更復(fù)雜和繁忙的場(chǎng)景。

1.3 Flexus 云服務(wù)器 X 實(shí)例使用場(chǎng)景

Flexus 云服務(wù)器 X 實(shí)例針對(duì)不同的使用場(chǎng)景展現(xiàn)出其獨(dú)特的優(yōu)勢(shì)：

1.電商直播：利用 X 實(shí)例搭建電商交易平臺(tái)，可以有效應(yīng)對(duì)電商市場(chǎng)的瞬息萬(wàn)變，從容處理業(yè)務(wù)壓力波動(dòng)，確保交易過程順暢無(wú)阻。

2.企業(yè)建站：面向博客、論壇和企業(yè)門戶等應(yīng)用場(chǎng)景，X 實(shí)例幫助企業(yè)高效傳播價(jià)值信息，促進(jìn)信息共享與交流，支持構(gòu)建多功能傳播和交互平臺(tái)。

3.個(gè)人開發(fā)測(cè)試：開發(fā)者在開發(fā)和測(cè)試過程中所需的環(huán)境資源可以通過 X 實(shí)例便捷獲取，不僅提高了搭建效率，而且降低了成本。

4.游戲服務(wù)器：適用于搭建游戲后臺(tái)服務(wù)器，強(qiáng)大的計(jì)算能力可以輕松應(yīng)對(duì)大量玩家同時(shí)在線的情況，同時(shí)支持平滑擴(kuò)容，快速應(yīng)對(duì)玩家數(shù)量增長(zhǎng)的需求，以及提供出色的網(wǎng)絡(luò)加速能力以提升用戶體驗(yàn)。

二、CodeX Docs 介紹

2.1 CodeX Docs 簡(jiǎn)介

CodeX Docs是一個(gè)免費(fèi)的文檔應(yīng)用程序，基于 Editor.js 平臺(tái)，為處理內(nèi)容提供了現(xiàn)代化的功能。無(wú)論是產(chǎn)品文檔、團(tuán)隊(duì)內(nèi)部文檔、個(gè)人筆記還是其他任何需求，都可以選擇使用它。

2.2 CodeX Docs 特點(diǎn)

???Editor.js 生態(tài)系統(tǒng)支持??? 文檔嵌套——?jiǎng)?chuàng)建你需要的任何結(jié)構(gòu)??? 靜態(tài)渲染??? 在電腦和移動(dòng)設(shè)備上都看起來(lái)很漂亮??? 漂亮的頁(yè)面 URL。易于閱讀且對(duì) SEO 友好。???鷹正在狩獵。已集成錯(cuò)誤跟蹤???向 Telegram / Slack 報(bào)告印刷錯(cuò)誤??? Yandex Metrica 集成??? 輕松部署—無(wú)需數(shù)據(jù)庫(kù)和其他依賴??? 配置簡(jiǎn)單??根據(jù)需要調(diào)整 UI。折疊部分，隱藏側(cè)邊欄

2.3 CodeX Docs 使用場(chǎng)景

1.產(chǎn)品文檔管理：企業(yè)可以使用 CodeX Docs來(lái)創(chuàng)建和維護(hù)產(chǎn)品手冊(cè)、用戶指南、API 文檔等。其強(qiáng)大的編輯功能和模塊化設(shè)計(jì)使得信息組織和更新變得簡(jiǎn)單高效。

2.團(tuán)隊(duì)協(xié)作與知識(shí)共享：團(tuán)隊(duì)成員可以利用 CodeX Docs共享項(xiàng)目計(jì)劃、會(huì)議記錄、研發(fā)筆記等，促進(jìn)團(tuán)隊(duì)內(nèi)部的信息流通和知識(shí)積累。實(shí)時(shí)協(xié)作功能確保所有成員都能及時(shí)獲取最新信息。

3.個(gè)人知識(shí)庫(kù)構(gòu)建：個(gè)人用戶可以將其作為個(gè)人筆記應(yīng)用，整理學(xué)習(xí)資料、研究筆記、旅行日記等。自定義模塊和主題支持個(gè)性化定制，滿足不同用戶的審美和功能需求。

4.教育與培訓(xùn)資源：教育機(jī)構(gòu)或在線課程平臺(tái)可以使用 CodeX Docs制作課程大綱、講義、實(shí)驗(yàn)指導(dǎo)書等教學(xué)材料，結(jié)合多媒體元素如圖片、視頻，提升學(xué)習(xí)體驗(yàn)。

5.項(xiàng)目提案與報(bào)告編寫：無(wú)論是商業(yè)提案、科研報(bào)告還是市場(chǎng)分析，CodeX Docs提供的豐富編輯工具和格式選項(xiàng)，幫助用戶專業(yè)地呈現(xiàn)內(nèi)容，提升文檔的視覺吸引力和說服力。

6.客戶服務(wù)與支持：企業(yè)可建立 FAQ（常見問題解答）庫(kù)、操作指南和故障排除手冊(cè)，提高客戶自助服務(wù)的能力，減輕客服壓力。

7.創(chuàng)意寫作與出版：作家、博主和自由撰稿人可以使用 CodeX Docs編寫文章、故事或劇本，利用其格式化工具和導(dǎo)出功能，輕松將作品發(fā)布到不同的平臺(tái)。

三、本次實(shí)踐介紹

3.1 本次實(shí)踐簡(jiǎn)介

1.本次實(shí)踐為個(gè)人測(cè)試學(xué)習(xí)環(huán)境，旨在快速部署應(yīng)用，生產(chǎn)環(huán)境請(qǐng)謹(jǐn)慎；2.本次實(shí)踐環(huán)境為華為云 Flexus 云服務(wù)器 X 實(shí)例，使用的操作系統(tǒng)為 openEuler 22.03 LTS；3.本次實(shí)踐在 Node.js 環(huán)境下部署 CodeX Docs 文檔工具。

3.2 本次環(huán)境規(guī)劃

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

4.1 購(gòu)買 Flexus 云服務(wù)器 X 實(shí)例

進(jìn)入華為云官網(wǎng)：https://activity.huaweicloud.com/，登錄自己的華為云賬號(hào)，進(jìn)入華為云首頁(yè)。

·鏡像選擇：本次實(shí)踐使用 openEuler 作為公共鏡像，請(qǐng)根據(jù)實(shí)際需求自定義選擇合適的操作系統(tǒng)鏡像。

·鏡像切換說明：參考的公共鏡像原為 Huawei Cloud EulerOS，但本次實(shí)踐中已切換至 openEuler。

·基礎(chǔ)配置參考：購(gòu)買時(shí)可參考以下基礎(chǔ)配置進(jìn)行選擇。

1.計(jì)費(fèi)模式：包年/包月，這里選擇此模式；2.區(qū)域：華北—北京四，可用區(qū)：隨機(jī)即可；3.實(shí)例規(guī)格：關(guān)閉性能模式，選擇自定義，4vCPUs | 12GiB；4.鏡像：公共鏡像，Huawei Cloud EulerOS，版本，Huawei Cloud EulerOS 2.0 Standard 64 bit(10GiB)；5.應(yīng)用加速：這里選擇不加速；6.存儲(chǔ)：系統(tǒng)盤，通用型 SSD100G；7.網(wǎng)絡(luò)：選擇默認(rèn)即可；8.安全組：選擇默認(rèn)即可；9.彈性公網(wǎng) IP：選擇“現(xiàn)在購(gòu)買”，全動(dòng)態(tài) BGP，帶寬 3Mbit/s；10.云服務(wù)器名稱：可自定義設(shè)置，這里選擇默認(rèn)的名稱；11.登錄憑證：自定義設(shè)置密碼；12.云備份：暫不購(gòu)買；其余配置默認(rèn)即可。

·確認(rèn)配置及購(gòu)買：在確認(rèn)配置頁(yè)面仔細(xì)檢查 Flexus 云服務(wù)器 X 實(shí)例的各項(xiàng)設(shè)置，確保無(wú)誤后點(diǎn)擊“立即購(gòu)買”，完成付款流程即可成功購(gòu)買。

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

進(jìn)入華為云 Flexus 云服務(wù)的控制臺(tái)，選擇 Flexus 云服務(wù)器 X 實(shí)例，可以看到已經(jīng)正在運(yùn)行的 Flexus 云服務(wù)器 X 實(shí)例。

4.3 使用 Xshell 遠(yuǎn)程連接

·復(fù)制 Flexus 云服務(wù)器 X 實(shí)例的彈性公網(wǎng) IP 地址

·主要填寫 Flexus 云服務(wù)器 X 實(shí)例的彈性公網(wǎng) IP 地址，輸入其登錄用戶和密碼，連接即可。

4.4 檢查操作系統(tǒng)版本

檢查 Flexus 云服務(wù)器 X 實(shí)例的操作系統(tǒng)版本，本次實(shí)踐選擇的版本為 openEuler 22.03 LTS

[root@flexusx-51a1 ~]# cat /etc/os-releaseNAME="openEuler"VERSION="22.03 LTS"ID="openEuler"VERSION_ID="22.03"PRETTY_NAME="openEuler 22.03 LTS"ANSI_COLOR="0;31"

4.5 檢查內(nèi)核版本

檢查當(dāng)前操作系統(tǒng)的內(nèi)核版本，當(dāng)前內(nèi)核版本為 5.10.0-60.109.0.136.oe2203.x86_64。

[root@flexusx-51a1 ~]# uname -r5.10.0-60.109.0.136.oe2203.x86_64

五、部署 Node.js 環(huán)境

5.1 下載 Node.js 安裝包

在/root 目錄下，下載 Node.js 安裝包，下載版本為 v16.17.0。

wget https://mirrors.aliyun.com/nodejs-release/v16.17.0/node-v16.17.0-linux-x64.tar.xz

5.2 解壓 Node.js 安裝包

在/root 目錄下，解壓 Node.js 安裝包

tar -xvJf node-v16.17.0-linux-x64.tar.xz

5.3 鏈接二進(jìn)制文件

將/root/node-v16.17.0-linux-x64/bin/下的二進(jìn)制文件鏈接到/usr/local/bin 下

ln -s /root/node-v16.17.0-linux-x64/bin/node /usr/local/bin/nodeln -s /root/node-v16.17.0-linux-x64/bin/npm /usr/local/bin/npm

5.4 配置環(huán)境變量

·在/etc/profile 文件中，新增以下兩行：

export NODE_HOME=/root/node-v16.17.0-linux-x64/bin/export PATH=$PATH:$NODE_HOME:/usr/local/bin/

·使變量生效

source /etc/profile

5.5 查看 node 版本

執(zhí)行以下命令，查看 node 和 npm 版本。

[root@flexusx-51a1 ~]# node -vv16.17.0[root@flexusx-51a1 ~]# npm -v8.15.0

六、安裝 yarn 工具（可選）

6.1 設(shè)置 npm 鏡像源

為了加速下載速度，可以將 npm 設(shè)置為國(guó)內(nèi)淘寶最新的鏡像源。

npm config set registry https://registry.npmmirror.com

執(zhí)行以下命令，查看 npm 鏡像源。

[root@flexusx-51a1 ~]# npm get registryhttps://registry.npmmirror.com/

6.2 安裝 yarn

執(zhí)行以下命令，安裝 yarn 工具。

npm install -g yarn

6.3 檢查 yarn 版本

檢查 yarn 版本，當(dāng)前安裝版本為 1.22.22。

[root@flexusx-51a1 ~]# yarn -v1.22.22

6.4 設(shè)置 yarn 鏡像源

·yarn 設(shè)置國(guó)內(nèi)淘寶鏡像源

yarn config set registry https://registry.npmmirror.com

·查看 yarn 鏡像源

yarn config get registry

七、部署 CodeX Docs 應(yīng)用

7.1 下載 CodeX Docs 項(xiàng)目

執(zhí)行以下命令，我們從 Github 拉取 CodeX Docs 項(xiàng)目源碼。

git clone https://github.com/codex-team/codex.docs.git

7.2 查看項(xiàng)目?jī)?nèi)容

執(zhí)行以下命令，查看 CodeX Docs 項(xiàng)目?jī)?nèi)容。

[root@flexusx-51a1 ~]# tree -L 2 ./codex.docs/./codex.docs/├──bin│ └──db-converter├──DEVELOPMENT.md├──docker│ └──Dockerfile.prod├──docker-compose.dev.yml├──docker-compose.yml├──docs-config.yaml├──LICENSE├──nodemon.json├──package.json├──public│ └──favicon.png├──README.md├──src│ ├──backend│ ├──frontend│ └──test├──tsconfig.json├──webpack.config.js└──yarn.lock8 directories, 13 files

7.3 進(jìn)入項(xiàng)目目錄

部署項(xiàng)目之前，我們先進(jìn)入 CodeX Docs 項(xiàng)目目錄。

[root@flexusx-51a1 ~]# cd codex.docs/[root@flexusx-51a1 codex.docs]# lsbin docker docker-compose.yml LICENSE package.json README.md tsconfig.json yarn.lockDEVELOPMENT.md docker-compose.dev.yml docs-config.yaml nodemon.json public src webpack.config.js

7.4 安裝依賴項(xiàng)

執(zhí)行以下命令，安裝項(xiàng)目相關(guān)依賴項(xiàng)。

npm install

7.5 復(fù)制配置文件

在./codex.docs 目錄下，將 docs-config.yaml 文件復(fù)制到當(dāng)前目錄，并修改文件名為 docs-config.local.yaml。在該配置文件中，我們可以在 auth 認(rèn)證部分設(shè)置訪問密碼，這里由于測(cè)試環(huán)境，直接使用默認(rèn)密碼，也可自行修改訪問密碼。

cp docs-config.yaml docs-config.local.yaml

[root@flexusx-51a1 codex.docs]# cat docs-config.local.yamlport: 3000host: "localhost"uploads:driver: "local"local:path: "./uploads"s3:bucket: "my-bucket"region: "eu-central-1"baseUrl: "http://docs-static.codex.so.s3-website.eu-central-1.amazonaws.com"keyPrefix: "/"accessKeyId: "my-access-key"secretAccessKey: "my-secret-key"frontend:title: "CodeX Docs"description: "Free Docs app powered by Editor.js ecosystemt"startPage: ""misprintsChatId: "12344564"yandexMetrikaId: ""carbon:serve: ""placement: ""menu:- "Guides"- title: "CodeX"uri: "https://codex.so"auth:password: secretpasswordsecret: supersecrethawk:# frontendToken: "123"# backendToken: "123"database:driver: local # you can change database driver here. 'mongodb' or 'local'local:path: ./db# mongodb:# uri: mongodb://localhost:27017/docs

7.6 啟動(dòng)服務(wù)

·可以執(zhí)行以下命令，前臺(tái)啟動(dòng) CodeX Docs 服務(wù)。

npm start

·也可以后臺(tái)啟動(dòng)啟動(dòng) CodeX Docs 服務(wù)。

[root@flexusx-51a1 codex.docs]# npm start > output.log 2>&1 &[1] 9688

·查看后臺(tái)運(yùn)行服務(wù)

[root@flexusx-51a1 codex.docs]# jobs[1]+ Running npm start > output.log 2>&1 &

八、訪問前準(zhǔn)備工作

8.1 設(shè)置防火墻與 selinux

·執(zhí)行以下命令，關(guān)閉防火墻。

systemctl stop firewalld && systemctl disable firewalld

·關(guān)閉 selinux

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

8.2 Flexus 云服務(wù)器 X 實(shí)例安全組配置

進(jìn)入 Flexus 云服務(wù)器 X 實(shí)例控制臺(tái)，進(jìn)行安全組規(guī)則配置。在安全組入方向規(guī)則上，放行 3000 端口。

九、訪問 CodeX Docs 首頁(yè)

9.1 訪問 CodeX Docs 初始頁(yè)

瀏覽器訪問地址：http://彈性公網(wǎng) IP 地址:3000，將 IP 替換為自己服務(wù)器 IP 地址。瀏覽器打開后，進(jìn)入 CodeX Docs 初始頁(yè)。

9.2 查詢?cè)L問密碼

新增頁(yè)面后需要填寫訪問密碼，訪問密碼在項(xiàng)目目錄的 docs-config.local.yaml 文件中設(shè)置，這里由于沒有設(shè)置，使用的是默認(rèn)密碼 secretpassword，我們查看 docs-config.local.yaml 即可知曉。

cat docs-config.local.yaml

9.3 編輯文檔

·點(diǎn)擊新增頁(yè)面

·選擇新增頁(yè)面后，需要填寫訪問密碼，使用剛才查詢的密碼登錄即可。

·在編輯器內(nèi)，編輯文檔內(nèi)容。

·在編輯器最下方，選擇保存文檔即可。

9.4 查看文檔效果

保存完畢后，可以看到 CodeX Docs 文檔效果。

十、使用體驗(yàn)與總結(jié)

在本次實(shí)踐中，我們成功地在華為云 Flexus 云服務(wù)器 X 實(shí)例上部署了 CodeX Docs 應(yīng)用，整個(gè)部署過程流暢無(wú)阻，使用體驗(yàn)令人印象深刻。華為云 Flexus X 實(shí)例憑借其卓越的性價(jià)比、強(qiáng)大的計(jì)算性能、可靠的穩(wěn)定性和高標(biāo)準(zhǔn)的安全保障，在眾多云服務(wù)中獨(dú)樹一幟。其穩(wěn)定的網(wǎng)絡(luò)連接和無(wú)延遲的操作，確保了高效的工作流程。依托華為云的強(qiáng)大支持，CodeX Docs 不僅提供了一個(gè)基于 Editor.js 平臺(tái)的現(xiàn)代化文檔處理工具，還適用于產(chǎn)品文檔、團(tuán)隊(duì)協(xié)作、個(gè)人筆記等多種場(chǎng)景，極大地提升了內(nèi)容管理的便捷性和靈活性。

抓住華為云 828 B2B 企業(yè)節(jié)的機(jī)遇，即刻體驗(yàn) Flexus X 實(shí)例帶來(lái)的超值優(yōu)惠，領(lǐng)略前沿技術(shù)和創(chuàng)新理念的完美結(jié)合。無(wú)論是高性能計(jì)算還是智能化監(jiān)控，每一處細(xì)節(jié)都展現(xiàn)了華為云對(duì)高品質(zhì)服務(wù)的執(zhí)著追求。選擇華為云，不僅意味著技術(shù)層面的躍升，更是邁向數(shù)字化轉(zhuǎn)型的關(guān)鍵一步。讓我們一起攜手前行，共創(chuàng)云端新時(shí)代！

審核編輯 黃宇