Docker Compose

Запустите полноценный бесплатный экземпляр Status200 на одном Linux-сервере с помощью Docker Compose. Эта страница проведёт вас от чистого сервера до работающего экземпляра, а затем расскажет об HTTPS, подготовке к продакшену, резервных копиях, обновлениях и удалении. Чтобы работать с кодом самого Status200, см. Локальная разработка.

Как это работает#

Docker Compose запускает каждую часть Status200 в виде контейнера на вашем сервере. Весь трафик входит через контейнер ingress, который направляет его в app. Приложение хранит данные в PostgreSQL, ClickHouse и Valkey. Встроенный зонд выполняет проверки ваших мониторов и отправляет результаты обратно через ingress.

Для продакшена большого масштаба или когда нужна высокая доступность используйте вместо этого Helm-чарт в Kubernetes: Docker Compose запускает по одной копии каждого сервиса на одном сервере.

Требования#

Выбирайте размер сервера по тому, что вы будете на нём запускать. Память и диск определяет телеметрия (логи, метрики, трассировки); когда узнаете свои объёмы, загляните в Подбор размеров и планирование ёмкости.

Минимум для домашней лаборатории подходит для личного и экспериментального использования — некоторые запускают Status200 на Raspberry Pi.

Также понадобятся:

• Docker с плагином Docker Compose v2 (команда docker compose).
• Git, чтобы загрузить Status200.
• Node.js и npm, которые запускают скрипты npm start и npm run update, оборачивающие Docker Compose.
• Свободные порты 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 доменное имя или IP-адрес, по которому к Status200 будут обращаться, без http://. Оставляйте localhost, только чтобы попробовать Status200 на своём компьютере.

   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 Dashboard по адресу /admin.

   Любой, кто может открыть страницу, сможет зарегистрироваться после вас. Чтобы запретить это, откройте Admin Dashboard, перейдите в Настройки > Аутентификация и выключите Разрешить регистрацию. Люди, которых вы приглашаете в проект, по-прежнему смогут создать учётную запись.

Настройка HTTPS#

Status200 отдаёт обычный HTTP, пока вы не выберете один из двух способов добавить HTTPS:

Если вы размещаете страницы статуса или панели на собственных доменах, проще доверить TLS самому Status200: ingress сам заказывает и отдаёт сертификаты этих доменов.

С HTTP_PROTOCOL=https Status200 строит ссылки HTTPS, держит cookie входа на HTTPS и просит браузеры открывать ваш HOST только по HTTPS. Браузер соблюдает это год, на любом порту этого имени, поэтому если HOST когда-нибудь снова должен будет отвечать по обычному HTTP, задайте HSTS_MAX_AGE_SECONDS=0 в config.env заранее: браузеры забудут правило при следующем посещении.

Status200 получает сертификат сам#

1. Направьте домен на сервер#

   Создайте для домена DNS-запись A (или AAAA для IPv6) со значением — публичным IP-адресом сервера. Если есть запись AAAA, включите также IPv6 для Status200: см. Адреса посетителей.

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 на другие порты, опубликованные только на loopback-адресе 127.0.0.1 этого сервера, чтобы посетители попадали в Status200 только через ваш прокси. Зонд и Runner используют сеть хоста и обращаются к Status200 через http://localhost, поэтому переезжают вместе с ним:

   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 учитывает ваш прокси и ingress Status200, чтобы для списков разрешённых IP и ограничений частоты Status200 читал настоящий адрес посетителя. Прибавляйте по единице за каждый следующий прокси, дописывающий в 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 проверяет http://localhost на порту 80, где будет ваш прокси, поэтому проверьте новый порт сами. Скрипт завершается строкой 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; если ваш сертификат получен иначе, укажите его пути. Проверьте файл и перезагрузите Nginx командой sudo nginx -t && sudo systemctl reload nginx.

   Оба отправляют X-Forwarded-Proto, который сообщает Status200, что посетитель пришёл по HTTPS. Любой другой прокси тоже должен его отправлять, иначе cookie входа страниц статуса и панелей на ваших собственных доменах не удерживаются на HTTPS.

5. Откройте экземпляр через прокси#

   Откройте https://status200.example.com. Вы должны увидеть страницу входа Status200, отданную с сертификатом вашего прокси.

Адреса посетителей#

Status200 учитывает каждого посетителя по адресу, с которого тот подключается: его читают ограничения входа, другие ограничения по адресу и списки разрешённых IP страниц статуса и дашбордов. Двум конфигурациям нужна настройка, чтобы этот адрес был собственным адресом посетителя:

Без IPv6 в сети Status200 Docker передаёт ему каждого посетителя, пришедшего по IPv6, с одного своего адреса, и 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 в своей сети. Ваши данные сохраняются. 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,.

Когда несколько человек входят с одного адреса частной сети, страница Состояние Status200 в Admin Dashboard сообщает об этом и называет настройку, которая это меняет.

Чек-лист для продакшена#

Docker Compose запускает по одной копии каждого сервиса на одном сервере, что подходит небольшим командам и домашним лабораториям. Прежде чем на него полагаться, пройдитесь по этому списку.

Смените пароль базы данных#

PostgreSQL сохраняет пароль, с которым была создана база, поэтому если сменить только DATABASE_PASSWORD в config.env, 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 доступен только с самого сервера: он отвечает на порту 5400 адреса 127.0.0.1. Чтобы делать резервные копии с другой машины, откройте с неё 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, например clickhouse-backup, или скопируйте том, пока Status200 остановлен.

Чтобы восстановить PostgreSQL, задайте значения DATABASE_RESTORE_* в config.env: 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.env новые параметры из config.example.env (ваши значения сохраняются), скачивает новые образы и перезапускает Status200. Как и npm start, он завершается строкой Status200 is up!

Переход на новую основную версию (например, с 13 на 14) может потребовать большего: прочитайте Обновление Status200 до новой версии, прежде чем начинать.

APP_TAG=release в config.env всегда скачивает последний релиз 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

Следующие шаги#