Docker Compose

使用 Docker Compose 在一台 Linux 伺服器上執行完整、免費的 Status200 執行個體。本頁帶你從一台全新的伺服器走到一個執行中的執行個體，接著說明 HTTPS、正式環境強化、備份、更新與移除。如果要開發 Status200 本身的程式碼，請參閱 本機開發。

運作方式#

Docker Compose 會把 Status200 的每個部分當作容器在你的伺服器上執行。所有流量都從 ingress 容器進入，再由它轉送到 app。應用程式把資料保存在 PostgreSQL、ClickHouse 和 Valkey 中。內建的探針會執行監控的檢查，並透過 ingress 回報結果。

對於大規模的正式環境，或需要高可用性時，請改用 Kubernetes 上的 Helm chart：Docker Compose 在一台伺服器上為每個服務只執行一份。

需求#

依照要在伺服器上執行的內容選擇伺服器規格。決定記憶體與磁碟用量的是遙測資料（日誌、指標、追蹤）；知道你的資料量後，請參閱 規模與容量規劃。

家庭實驗室最低配置適合個人與實驗用途——有些使用者在 Raspberry Pi 上執行 Status200。

你還需要：

• Docker 以及 Docker Compose v2 外掛程式（也就是 docker compose 指令）。
• Git，用來取得 Status200。
• Node.js 和 npm，用來執行包裝 Docker Compose 的 npm start 與 npm run update 指令碼。
• 伺服器上未被占用的連接埠 80 和 443。下表列出 Status200 在主機上使用的每個連接埠。

另有一段安裝過程的 影片導覽。

安裝 Status200#

1. 複製 release 分支#

   release 分支包含最新版本的檔案。

   Bash

   git clone --depth 1 --single-branch --branch release https://git.wilix.dev/status200/status200.git
   cd oneuptime

2. 建立 config.env#

   Status200 的所有設定都在 config.env 中。從範例檔案開始：

   Bash

   cp config.example.env config.env

3. 設定主機名稱#

   開啟 config.env，把 HOST 設為大家連到 Status200 時使用的網域名稱或 IP 位址，不要加上 http://。只有在自己的電腦上試用 Status200 時才保留 localhost。

   config.envINI

   HOST=status200.example.com

4. 產生隨機密鑰#

   範例檔案附帶的預留位置密鑰在 GitHub 上是公開的。請把每一個都換成各自的隨機值：

   Bash

   while grep -q "please-change-this-to-random-value" config.env; do
     sed -i "0,/please-change-this-to-random-value/{s/please-change-this-to-random-value/$(openssl rand -hex 32)/}" config.env
   done
   grep -c "please-change-this" config.env

   最後一個指令會輸出 0：表示沒有剩下任何預留位置。這個迴圈使用 GNU sed，每台 Linux 伺服器都有。它會填入以下設定：

   設定	保護的內容
   ONEUPTIME_SECRET	Status200 自身服務之間的呼叫。
   ENCRYPTION_SECRET	Status200 儲存的密鑰（例如整合權杖與 SMTP 密碼），以及它簽發的登入權杖。
   DATABASE_PASSWORD、CLICKHOUSE_PASSWORD、VALKEY_PASSWORD	三個資料存放區。
   REGISTER_PROBE_KEY	向你的執行個體註冊探針。
   GLOBAL_PROBE_1_KEY、GLOBAL_PROBE_2_KEY	Docker Compose 可以執行的全域探針（預設執行 probe-1）。
   STATUS200_RUNNER_KEY	內建的 Runner。
   GLOBAL_RUNNER_KEY	內建的全域 Runner，執行所有專案的 JavaScript 步驟。

   重要

   請在第一次啟動前設定這些密鑰，之後保持不變。PostgreSQL 只在建立資料庫時採用密碼，而之後變更 ENCRYPTION_SECRET 會讓所有以舊密鑰加密的值都無法讀取。如果第一次啟動時 DATABASE_PASSWORD 仍是預留位置，npm start 會在 PostgreSQL 建立資料庫之前為它設定一個隨機值。

5. 啟動 Status200#

   npmDocker CLI

   npm

   Bash

   npm start

   Docker CLI

   Bash

   (export $(grep -v '^#' config.env | xargs) && docker compose up --remove-orphans -d)

   第一次啟動需要幾分鐘：Docker 要下載映像檔，Status200 要建立資料庫。npm start 會等待每個部分都有回應，最後輸出 Status200 is up!

6. 建立第一個帳號#

   開啟 http:// 加上你的 HOST（例如 http://localhost）並註冊。新執行個體上的第一個帳號會成為它的主要管理員，可以在 /admin 開啟 Admin Dashboard。

   在你之後，任何能連到該頁面的人都可以註冊。若要阻止這種情況，請開啟 Admin Dashboard，前往 設定 > 驗證，並關閉 允許註冊。你邀請加入專案的人仍然可以建立帳號。

設定 HTTPS#

在你選擇以下兩種新增 HTTPS 的方式之一前，Status200 只提供一般的 HTTP：

如果你把狀態頁面或儀表板放在自訂網域上，讓 Status200 處理 TLS 是比較簡單的做法：ingress 會自行申請並提供這些網域的憑證。

設定 HTTP_PROTOCOL=https 後，Status200 會產生 HTTPS 連結，把登入 Cookie 留在 HTTPS 上，並告訴瀏覽器只透過 HTTPS 存取你的 HOST。瀏覽器會在一年內、在這個名稱的所有連接埠上遵守這一點；所以如果 HOST 將來需要重新透過一般的 HTTP 回應，請提前一段時間把 HSTS_MAX_AGE_SECONDS=0 寫進 config.env：瀏覽器會在下次造訪時忘掉這條規則。

讓 Status200 取得憑證#

1. 將網域指向伺服器#

   為你的網域建立一筆 DNS A 記錄（IPv6 用 AAAA），值為伺服器的公開 IP 位址。如果新增了 AAAA 記錄，也要為 Status200 開啟 IPv6：請參閱訪客位址。

2. 開啟憑證申請#

   在 config.env 中設定以下值：

   config.envINI

   HOST=status200.example.com
   PROVISION_SSL=true
   HTTP_PROTOCOL=https

   HOST 必須是網域名稱：Status200 無法為 IP 位址或 localhost 取得憑證。

3. 使用新設定重新啟動#

   Bash

   npm start

4. 透過 HTTPS 開啟你的執行個體#

   開啟 https://status200.example.com。Status200 會在啟動時申請憑證，之後每小時檢查一次，並在剩餘效期少於 30 天時更新。在第一張憑證到來之前（通常在幾分鐘內），ingress 會提供一張暫時的自我簽署憑證，瀏覽器會發出警告。

使用你自己的反向代理#

以下步驟在與 Status200 相同的伺服器上執行代理。如果你的代理執行在另一台機器上，請略過第一個步驟，把代理指向這台伺服器的連接埠 80，並用雲端供應商的防火牆只讓代理連到連接埠 80 和 443：繞過代理連到 Status200 的訪客，可以自己選擇 Status200 用來計算他的位址。

1. 將 ingress 移出連接埠 80 和 443#

   代理需要連接埠 80 和 443，所以要把 ingress 移到其他連接埠，並且只發布在這台伺服器的回送位址 127.0.0.1 上，讓訪客只能透過你的代理連到 Status200。探針與 Runner 使用主機的網路，透過 http://localhost 連到 Status200，因此它們也要一起調整：

   config.envINI

   ONEUPTIME_HTTP_PORT=127.0.0.1:8080
   STATUS_PAGE_HTTPS_PORT=127.0.0.1:8443
   GLOBAL_PROBE_1_STATUS200_URL=http://localhost:8080
   ONEUPTIME_RUNNER_STATUS200_URL=http://localhost:8080

2. 告訴 Status200 它位於代理之後#

   config.envINI

   HOST=status200.example.com
   HTTP_PROTOCOL=https
   PROVISION_SSL=false
   TRUSTED_PROXY_HOPS=2

   HTTP_PROTOCOL=https 會讓 Status200 產生的連結使用 HTTPS。TRUSTED_PROXY_HOPS=2 會把你的代理和 Status200 的 ingress 都算進去，讓 Status200 在 IP 允許清單與速率限制中讀取訪客的真實位址。每多一層會附加 X-Forwarded-For 的代理（例如 CDN 或負載平衡器），就再加一。

3. 在新連接埠上重新啟動 Status200#

   Bash

   (export $(grep -v '^#' config.env | xargs) && docker compose up --remove-orphans -d)
   bash Tests/Scripts/status-check.sh localhost:8080

   npm start 檢查的是連接埠 80 上的 http://localhost，而那裡將是你的代理，所以請自行檢查新連接埠。指令碼最後輸出 Status200 is up!

4. 設定代理#

   CaddyNginx

   Caddy

   Caddyfile

   status200.example.com {
       reverse_proxy localhost:8080
   }

   Caddy 會自行取得並更新憑證、把 HTTP 重新導向到 HTTPS，並放行 WebSocket 連線。修改檔案後請重新載入 Caddy，例如使用 sudo systemctl reload caddy。

   Nginx

   /etc/nginx/conf.d/status200.confNginx

   map $http_upgrade $status200_connection_upgrade {
       default upgrade;
       ""      close;
   }
   
   server {
       listen 80;
       server_name status200.example.com;
       return 301 https://$host$request_uri;
   }
   
   server {
       listen 443 ssl;
       server_name status200.example.com;
   
       ssl_certificate     /etc/letsencrypt/live/status200.example.com/fullchain.pem;
       ssl_certificate_key /etc/letsencrypt/live/status200.example.com/privkey.pem;
   
       # The limits Status200's own ingress uses.
       client_max_body_size 50M;
       proxy_read_timeout 300s;
       proxy_send_timeout 300s;
   
       proxy_http_version 1.1;
       proxy_set_header Host $host;
       proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
       proxy_set_header X-Forwarded-Proto $scheme;
       proxy_set_header Upgrade $http_upgrade;
       proxy_set_header Connection $status200_connection_upgrade;
   
       location / {
           proxy_pass http://127.0.0.1:8080;
       }
   
       # MCP clients keep a stream open.
       location /mcp {
           proxy_pass http://127.0.0.1:8080;
           proxy_buffering off;
           proxy_read_timeout 86400s;
           proxy_send_timeout 86400s;
       }
   }

   憑證路徑是 Certbot 存放 Let's Encrypt 憑證的位置；如果你的憑證來自其他地方，請使用它自己的路徑。使用 sudo nginx -t && sudo systemctl reload nginx 檢查檔案並重新載入 Nginx。

   兩者都會傳送 X-Forwarded-Proto，它告訴 Status200 訪客是透過 HTTPS 來的。其他任何代理也必須傳送它，否則你自訂網域上的狀態頁面與儀表板的登入 Cookie 不會被留在 HTTPS 上。

5. 透過代理開啟你的執行個體#

   開啟 https://status200.example.com。你應該會看到 Status200 的登入頁面，使用的是你代理的憑證。

訪客位址#

Status200 依訪客連線時所用的位址來計算每位訪客：登入限制、其他依位址的限制，以及狀態頁和儀表板的 IP 允許清單，都會讀取這個位址。有兩種部署需要一項設定，才能讓這個位址是訪客自己的位址：

Status200 的網路沒有開啟 IPv6 時，Docker 會用它自己的一個位址把每位透過 IPv6 來的訪客轉交給 Status200，Status200 就會把他們全部算作同一位訪客：一個人的登入失敗可能會把其他人鎖在外面。開啟 IPv6 需要 Docker Engine 27 或更新版本（docker version 會顯示你的版本）。

1. 開啟 IPv6#

   建立 docker-compose.override.yml（放在 docker-compose.yml 旁邊），或把以下內容加到你已有的檔案中；npm start 和 npm run update 會讀取它：

   docker-compose.override.ymlYAML

   networks:
     oneuptime:
       enable_ipv6: true

2. 重新啟動 Status200#

   Bash

   npm stop
   npm start

   Status200 會先停止，再於網路開啟 IPv6 的情況下重新啟動。你的資料會保留。如果你自己的容器（例如反向代理）仍連接在 Status200 的網路上，Docker 無法刪除這個網路：請先把它從 Status200 的網路中斷連線，之後再連接回來。如果 npm start 因 has active endpoints 而停止，請中斷它的連線，然後再次執行 npm stop 和 npm start。

3. 檢查網路#

   Bash

   docker network ls --quiet --filter name=_oneuptime | xargs docker network inspect | grep EnableIPv6

   它會輸出 "EnableIPv6": true,。

當多人從同一個私人網路位址登入時，Admin Dashboard 的 Status200 健康狀態 頁面會指出這一點，並列出可以改變它的設定。

正式環境檢查清單#

Docker Compose 在一台伺服器上為每個服務只執行一份，適合小型團隊與家庭實驗室。在依賴它之前，請逐項檢查這份清單。

變更資料庫密碼#

PostgreSQL 會一直使用建立時的密碼，所以只變更 config.env 中的 DATABASE_PASSWORD 會讓 Status200 無法連到自己的資料庫。要為以預留位置啟動過的安裝設定專屬密碼，請同時在 PostgreSQL 和 config.env 中變更它，然後重新啟動 Status200：

NEW_PASSWORD=$(openssl rand -hex 32) &&
  (export $(grep -v '^#' config.env | xargs) && docker compose exec -T postgres psql -U "$DATABASE_USERNAME" -d "$DATABASE_NAME" -c "ALTER USER \"$DATABASE_USERNAME\" PASSWORD '$NEW_PASSWORD'") &&
  sed -i "s/^DATABASE_PASSWORD=.*/DATABASE_PASSWORD=$NEW_PASSWORD/" config.env
npm start

如果你設定了 DATABASE_BACKUP_PASSWORD 和 DATABASE_RESTORE_PASSWORD，也請為它們填入新值。

備份與還原#

PostgreSQL 保存你設定的一切：監控、事件、狀態頁面、使用者。npm run backup 會把它傾印到 Backups 資料夾中的一個檔案。

1. 為備份指令碼提供資料庫密碼#

   在 config.env 中，把 DATABASE_BACKUP_PASSWORD 設為 DATABASE_PASSWORD 的值。指令碼把 config.env 當作純文字讀取，因此它附帶的 ${DATABASE_PASSWORD} 永遠不會被替換。

2. 執行備份#

   Bash

   npm run backup

   它會詢問你的 sudo 密碼，並寫入 Backups/db-<day of the month>.backup，因此每天的備份會取代一個月前的備份。請至少每天執行一次。

3. 把備份複製到伺服器以外#

   與資料庫位於同一顆磁碟上的備份，無法在這顆磁碟損毀後保存下來。

只有伺服器本機能連到 PostgreSQL：它在 127.0.0.1 的連接埠 5400 上回應。要從另一台機器備份它，請在那台機器上開一條 SSH 通道，然後連到那台機器自己的連接埠 5400：

ssh -N -L 5400:127.0.0.1:5400 you@status200.example.com

services:
  postgres:
    ports:
      - "10.0.0.5:5401:5432"

ClickHouse 把遙測資料保存在 Docker 磁碟區 status200_clickhouse 中，沒有任何指令碼會備份它。如果需要保留這些遙測資料，請使用 clickhouse-backup 等 ClickHouse 工具備份該磁碟區，或在 Status200 停止時複製它。

若要還原 PostgreSQL，請在 config.env 中設定 DATABASE_RESTORE_* 值：與備份時一樣，把 DATABASE_RESTORE_PASSWORD 設為 DATABASE_PASSWORD 的值，並把 DATABASE_RESTORE_FILENAME 設為要還原的備份，例如 db-31.backup。然後執行 bash restore.sh。它還原的目標資料庫必須已經存在；在執行中的安裝上，它是存在的。

更新 Status200#

先備份，然後執行：

git checkout release
git pull
npm run update

npm run update 會詢問你的 sudo 密碼，把 config.example.env 中的新設定加入你的 config.env（你自己的值保持不變），下載新映像檔並重新啟動 Status200。與 npm start 一樣，它最後輸出 Status200 is up!

升級到新的主要版本（例如從 13 到 14）可能需要更多步驟：開始前請閱讀 升級 Status200。

config.env 中的 APP_TAG=release 一律下載 Community Edition 的最新版本。若要固定在某個版本，請把 APP_TAG 設為該版本號碼，例如 14.0.22。Enterprise Edition 的標籤則是 enterprise-release 和 enterprise-14.0.22。

移除 Status200#

停止 Status200 並移除它的容器與網路：

npm run down

你的資料會保留在 status200_postgres 和 status200_clickhouse 磁碟區中，oneuptime 資料夾也會保留 config.env 和你的備份。若也要刪除資料：

(export $(grep -v '^#' config.env | xargs) && docker compose down --volumes --remove-orphans)

然後刪除 oneuptime 資料夾。

疑難排解#

sudo usermod -aG docker $USER

npm run ps
npm run logs

(export $(grep -v '^#' config.env | xargs) && docker compose logs app) | grep -A 5 CoreSSL

後續步驟#