Docker Compose

با Docker Compose یک نمونهٔ کامل و رایگان Status200 را روی یک سرور Linux اجرا کنید. این صفحه شما را از یک سرور تازه به یک نمونهٔ در حال اجرا می‌رساند و سپس 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 را در بر می‌گیرند.
• درگاه‌های آزاد ۸۰ و ۴۴۳ روی سرور. جدول زیر همهٔ درگاه‌هایی را که 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 تا وقتی یکی از دو راه افزودن HTTPS را برنگزینید، HTTP ساده ارائه می‌کند:

اگر صفحه‌های وضعیت یا داشبوردها را روی دامنه‌های سفارشی می‌گذارید، سپردن TLS به Status200 ساده‌ترین راه است: ingress خودش گواهی آن دامنه‌ها را سفارش می‌دهد و ارائه می‌کند.

با HTTP_PROTOCOL=https، Status200 پیوندهای HTTPS می‌سازد، کوکی‌های ورود را روی 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 هنگام اجرا گواهی را سفارش می‌دهد، سپس هر ساعت آن را بررسی می‌کند و وقتی کمتر از ۳۰ روز از اعتبارش مانده باشد، تمدیدش می‌کند. تا رسیدن نخستین گواهی، که معمولاً چند دقیقه طول می‌کشد، ingress یک گواهی موقت خودامضا ارائه می‌دهد و مرورگر به شما هشدار می‌دهد.

استفاده از پراکسی معکوس خودتان#

این گام‌ها پراکسی را روی همان سروری اجرا می‌کنند که Status200 روی آن است. اگر پراکسی شما روی ماشین دیگری اجرا می‌شود، گام نخست را رد کنید، پراکسی را به درگاه ۸۰ این سرور نشانه بروید و با فایروال ارائه‌دهندهٔ ابری خود بگذارید فقط پراکسی به درگاه‌های ۸۰ و ۴۴۳ برسد: بازدیدکننده‌ای که بدون گذر از پراکسی به Status200 می‌رسد، می‌تواند نشانی‌ای را برگزیند که Status200 او را با آن می‌شمارد.

1. ingress را از درگاه‌های ۸۰ و ۴۴۳ جابه‌جا کنید#

   پراکسی به درگاه‌های ۸۰ و ۴۴۳ نیاز دارد، پس ingress را به درگاه‌های دیگری ببرید و آن‌ها را فقط روی نشانی loopback این سرور، 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 پراکسی شما و ingress در Status200 را می‌شمارد، تا 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 نشانی 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 را می‌گذارد؛ اگر گواهی شما از جای دیگری آمده است، مسیرهای خودش را به کار ببرید. فایل را بررسی کنید و Nginx را با sudo nginx -t && sudo systemctl reload nginx دوباره بارگذاری کنید.

   هر دو X-Forwarded-Proto را می‌فرستند که به Status200 می‌گوید بازدیدکننده از راه HTTPS آمده است. هر پراکسی دیگری هم باید آن را بفرستد، وگرنه کوکی‌های ورود صفحه‌های وضعیت و داشبوردهای روی دامنه‌های سفارشی شما روی HTTPS نگه داشته نمی‌شوند.

5. نمونهٔ خود را از راه پراکسی باز کنید#

   https://status200.example.com را باز کنید. باید صفحهٔ ورود Status200 را ببینید که با گواهی پراکسی شما ارائه شده است.

نشانی بازدیدکنندگان#

Status200 هر بازدیدکننده را با نشانی‌ای می‌شمارد که از آن وصل می‌شود: محدودیت‌های ورود، دیگر محدودیت‌های هر نشانی و فهرست‌های مجاز IP صفحه‌های وضعیت و داشبوردها همه همین نشانی را می‌خوانند. دو چیدمان به یک تنظیم نیاز دارند تا این نشانی، نشانی خود بازدیدکننده باشد:

بدون IPv6 روی شبکهٔ Status200، Docker هر بازدیدکننده‌ای را که از راه IPv6 می‌آید از یک نشانی خودش به Status200 می‌سپارد و Status200 همهٔ آن‌ها را یک بازدیدکننده می‌شمارد: ورودهای ناموفق یک نفر می‌تواند دیگران را مسدود کند. روشن کردن IPv6 به Docker Engine ۲۷ یا تازه‌تر نیاز دارد (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 می‌رسد: روی درگاه ۵۴۰۰ از 127.0.0.1 پاسخ می‌دهد. برای پشتیبان‌گیری از آن از ماشینی دیگر، از آن ماشین یک تونل SSH باز کنید و سپس به درگاه ۵۴۰۰ خود آن ماشین وصل شوید:

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.example.env را به config.env شما می‌افزاید (مقادیر خودتان می‌مانند)، ایمیج‌های تازه را می‌گیرد و Status200 را دوباره راه‌اندازی می‌کند. مانند npm start، با Status200 is up! تمام می‌شود.

رفتن به یک نسخهٔ اصلی تازه (برای نمونه از ۱۳ به ۱۴) ممکن است کار بیشتری بخواهد: پیش از شروع، ارتقای 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

گام‌های بعدی#