MCSManager/README_TW.md at master · gkchp/MCSManager

English - 简体中文 - 繁體中文 - Deutsch - Português BR - 日本語 - Spanish - Thai

這是什麼？

MCSManager Panel（簡稱：MCSM Panel）是一個快速部署、支援分散式架構、多使用者、簡單現代的 Minecraft、Steam 和其他遊戲伺服器網頁管理面板。

MCSManager 在 Minecraft 和 Steam 遊戲社群中廣受歡迎。它幫助您集中管理多台實體伺服器，讓您可以在任何主機上建立遊戲伺服器，並提供安全可靠的多使用者權限系統，可以輕鬆幫助您管理多個伺服器。它一直為 Minecraft、Terraria 和 Steam 遊戲伺服器的管理員、營運人員和個人開發者提供健康的軟體支援。

MCSM 同樣也考慮了商業應用，例如由 IDC 服務提供商進行的私有伺服器託管和銷售。多家中小型企業已經將此面板用作伺服器管理和銷售平台的結合。此外，它支援多語言環境，使其可供不同國家和地區的用戶訪問。

功能特色

使用應用程式市場輕鬆一鍵部署 Minecraft 或 Steam 遊戲伺服器。
相容於大多數 Steam 遊戲伺服器，如 Palworld、Squad、Project Zomboid 和 Terraria 等。
網頁介面支援拖放卡片佈局，建立您偏好的介面佈局。
支援 Docker Hub 上的所有映像，支援多使用者，支援商業實例銷售服務。
支援分散式架構，一個網頁介面可以同時管理多台機器。
簡單的技術堆疊，只需精通 TypeScript 即可完成整個 MCSManager 開發！
更多...

執行環境

控制面板可以在 Windows 和 Linux 平台上執行，無需安裝資料庫，只需安裝 Node.js 環境和幾個解壓縮命令。

必須使用 Node.js 16.20.2 或更高版本，建議使用最新的 LTS 版本。

官方文檔

英語：https://docs.mcsmanager.com/

中文：https://docs.mcsmanager.com/zh_cn/

安裝

Windows

對於 Windows 系統，已整合成直接運行版本，下载即可運行:

壓縮包：https://download.mcsmanager.com/mcsmanager_windows_release.zip

雙擊 start.bat 即可啟動面板和守護進程。

Linux

一行命令快速安裝

sudo su -c "wget -qO- https://script.mcsmanager.com/setup.sh | bash"

安裝後使用

systemctl start mcsm-{web,daemon} # 啟動面板
systemctl stop mcsm-{web,daemon}  # 停止面板

腳本僅適用於 Ubuntu/Centos/Debian/Archlinux
面板程式碼和執行環境會自動安裝在 /opt/mcsmanager/ 目錄中。

Linux 手動安裝

如果一鍵安裝不工作，您可以嘗試此步驟進行手動安裝。

# 切換到安裝目錄。如果不存在，請先使用 'mkdir /opt/' 建立。
cd /opt/
# 下載執行環境（Node.js）。如果您已經安裝了 Node.js 16+，請忽略此步驟。
wget https://nodejs.org/dist/v20.11.0/node-v20.11.0-linux-x64.tar.xz
# 解壓縮檔案
tar -xvf node-v20.11.0-linux-x64.tar.xz
# 將程式加入系統環境變數。
ln -s /opt/node-v20.11.0-linux-x64/bin/node /usr/bin/node
ln -s /opt/node-v20.11.0-linux-x64/bin/npm /usr/bin/npm

# 準備安裝目錄。
mkdir /opt/mcsmanager/
cd /opt/mcsmanager/

# 下載 MCSManager。
wget https://github.com/MCSManager/MCSManager/releases/latest/download/mcsmanager_linux_release.tar.gz
tar -zxf mcsmanager_linux_release.tar.gz

# 安裝相依性。
chmod 775 install.sh
./install.sh

# 請開啟兩個終端機或 screen。

# 首先啟動 node 程式。
./start-daemon.sh

# 啟動網頁服務（在第二個終端機或 screen 中）。
./start-web.sh

# 訪問 http://<公開 IP>:23333/ 查看面板。
# 通常，網頁應用程式會自動掃描並連接到本地守護程式。

此安裝方法不會自動將面板註冊到系統服務，因此您必須使用 screen 軟體來管理它。如果您希望系統服務接管 MCSManager，請參考文件。

Mac OS

# 首先安裝 Node.js，如果您已經安裝，可以跳過此步驟。
# Node.js 建議安裝最新的 LTS 版本。
brew install node
node -v
npm -v

# 使用 curl 下載檔案
curl -L https://github.com/MCSManager/MCSManager/releases/latest/download/mcsmanager_linux_release.tar.gz -o mcsmanager_linux_release.tar.gz

# 解壓縮檔案（與原始命令相同）
tar -zxf mcsmanager_linux_release.tar.gz

cd mcsmanager

# 安裝相依性。
chmod 775 install.sh
./install.sh

# 請開啟兩個終端機或 screen。

# 首先啟動 node 程式。
./start-daemon.sh

# 啟動網頁服務（在第二個終端機或 screen 中）。
./start-web.sh

# 訪問 http://localhost:23333/ 查看面板。
# 通常，網頁應用程式會自動掃描並連接到本地守護程式。

通過 Docker 安裝

使用 docker-compose.yml 安裝面板，請注意您需要修改裡面的所有 <CHANGE_ME_TO_INSTALL_PATH> 為您的實際安裝目錄。

services:
  web:
    image: githubyumao/mcsmanager-web:latest
    ports:
      - "23333:23333"
    volumes:
      - /etc/localtime:/etc/localtime:ro
      - <CHANGE_ME_TO_INSTALL_PATH>/web/data:/opt/mcsmanager/web/data
      - <CHANGE_ME_TO_INSTALL_PATH>/web/logs:/opt/mcsmanager/web/logs

  daemon:
    image: githubyumao/mcsmanager-daemon:latest
    restart: unless-stopped
    ports:
      - "24444:24444"
    environment:
      - MCSM_DOCKER_WORKSPACE_PATH=<CHANGE_ME_TO_INSTALL_PATH>/daemon/data/InstanceData
    volumes:
      - /etc/timezone:/etc/timezone:ro
      - /etc/localtime:/etc/localtime:ro
      - <CHANGE_ME_TO_INSTALL_PATH>/daemon/data:/opt/mcsmanager/daemon/data
      - <CHANGE_ME_TO_INSTALL_PATH>/daemon/logs:/opt/mcsmanager/daemon/logs
      - /var/run/docker.sock:/var/run/docker.sock

使用 docker-compose 啟用。

mkdir -p <CHANGE_ME_TO_INSTALL_PATH>
cd <CHANGE_ME_TO_INSTALL_PATH>
vim docker-compose.yml # 這裡寫入上面的docker-compose.yml的內容
docker compose pull && docker compose up -d

注意：使用 Docker 安裝後，Web 端可能會無法再自動連接到 Daemon。

此時如果你進入面板，應該會出現一些錯誤，因為面板 Web 端沒有成功連接到守護進程端，你需要新建節點讓它們聯繫到一起。

程式碼貢獻

貢獻程式碼前必須閱讀：MCSManager#599
程式碼需要維持現有格式，不允許過度的程式碼格式化。
所有程式碼必須符合國際化標準。

開發

專案結構

整體專案共分為三個部分：

網頁後端（panel 資料夾）
被控節點端（daemon 資料夾）
網頁前端（frontend 資料夾）

網頁後端職責

使用者管理
連接節點
大多數操作的權限驗證與授權
API 介面提供
更多...

節點端職責

真實的程序管理（你的實例程序實際運行處）
Docker 容器管理
檔案管理
即時終端
更多...

網頁前端的功能

使用者 UI 支援
與 Web 後端互動
部分功能可直接與節點端溝通，以減少大量流量壓力

建立環境

請參閱：DEVELOPMENT_ZH.md

瀏覽器相容性

支援 Chrome Firefox Safari Opera 等現代主流瀏覽器。
已放棄對 IE 瀏覽器的支援。

錯誤回報

歡迎回報發現的任何問題，我們會迅速修復。

如果您發現不便公開的嚴重安全漏洞，請發送電子郵件至：support@mcsmanager.com。安全問題修復後，發現者的姓名將附加在程式碼中。

貢獻者

授權條款

此專案遵循 Apache License 2.0 授權條款。

FilesExpand file tree

README_TW.md

Latest commit

History