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

后续步骤#