Встановлення з Docker

Обидва способи запускають той самий docker-compose.yml. Інсталятор також генерує справжні секрети й перевіряє конфігурацію, перш ніж щось запустити, тож користуйтеся ним, якщо немає причин робити інакше.

Інсталятор

1. Запустіть інсталятор

   curl -fsSL https://railhook.io/install.sh | bash

   Він перевіряє Docker, Compose, пам’ять, диск і порт. Потім записує ~/railhook: docker-compose.yml, закріплений на останньому релізі, .env зі згенерованими секретами та допоміжний скрипт railhook. Наостанок запускає стек і чекає, доки API відповість. Перший запуск виконує міграції бази даних і створює топіки Kafka, тож може тривати кілька хвилин.

2. Відкрийте панель керування

   Перейдіть на http://localhost (або http://<server-ip>; додайте :<port>, якщо встановлювали з --port) і зареєструйтеся. Поки поштовий сервер не налаштовано, обліковий запис активний одразу.

3. Збережіть резервну копію .env

   WEBHOOK_ENCRYPTION_KEY і WEBHOOK_ENCRYPTION_SALT із цього файлу шифрують кожен секрет ендпоінта в базі даних. Резервна копія бази, відновлена без цього файлу, дасть рядки, які ніщо не зможе прочитати.

Параметри інсталятора

Передавайте параметри через конвеєр за допомогою bash -s --:

curl -fsSL https://railhook.io/install.sh | bash -s -- --dir /opt/railhook --port 8080

Параметр	Дія
--dir <path>	Куди встановити. Типово ~/railhook
--version <tag>	Реліз, на якому закріпитися, v2.12.0 або новіший. Типово — останній
--port <port>	Єдиний опублікований порт. Типово 80, або 8080 з --behind-proxy
--domain <host>	Обслуговувати на цьому домені через HTTPS. Див. Домен і HTTPS
--behind-proxy	Разом із --domain: TLS завершує ваш власний зворотний проксі, а панель слухає для нього на 127.0.0.1
--email <address>	Куди Let’s Encrypt надсилатиме попередження про закінчення терміну сертифіката
--no-start	Записати файли й нічого не запускати
--yes	Не питати перед використанням непорожнього каталогу
--check	Лише запустити перевірки системи та конфігурації
--uninstall	Зупинити стек і видалити контейнери. Томи з даними лишаються
--purge	Видалити встановлення разом із томами даних

Щоденні команди

Запускайте з каталогу встановлення:

Команда	Що робить
./railhook status	Показує контейнери та їхній стан
./railhook logs [service]	Стежить за журналами, наприклад ./railhook logs api
./railhook start / stop / restart	Запускає, зупиняє або перезапускає стек
./railhook upgrade [version]	Робить резервну копію, потім оновлює. Див. Оновлення й резервні копії
./railhook backup	Записує дамп бази даних у каталог
./railhook doctor	Повторно запускає всі перевірки на файлах із диска

Будь-який інший аргумент передається просто в Docker Compose, тож ./railhook ps чи ./railhook up -d працюють, як очікується.

Docker Compose вручну

1. Завантажте файл Compose і каталог налаштувань

   mkdir railhook && cd railhook
   curl -fsSLO https://raw.githubusercontent.com/vadymkykalo/railhook/main/docker-compose.yml
   curl -fsSL https://raw.githubusercontent.com/vadymkykalo/railhook/main/.env.dist -o .env

2. Замініть публічні секрети

   Значення в .env.dist публічні. Згенеруйте власні для кожного з них:

   .env

   WEBHOOK_ENCRYPTION_KEY=   # openssl rand -base64 32
   WEBHOOK_ENCRYPTION_SALT=  # openssl rand -base64 16
   JWT_SECRET=               # openssl rand -base64 48
   POSTGRES_PASSWORD=        # must equal DB_PASSWORD
   DB_PASSWORD=
   REDIS_PASSWORD=

   Задайте в APP_BASE_URL і CORS_ALLOWED_ORIGINS адресу, яку відкриватимуть користувачі. RAILHOOK_PORT у цьому файлі — 8080.

3. Запустіть із вбудованою базою даних

   COMPOSE_PROFILES=embedded-db docker compose up -d

4. Перевірте

   curl -f http://localhost:8080/actuator/health/liveness
   curl -o /dev/null -w '%{http_code}\n' http://localhost:8080/api/v1/projects   # expect 401

Порада

Щоб використати керовану PostgreSQL, приберіть embedded-db із COMPOSE_PROFILES і задайте DB_HOST, DB_PORT, DB_NAME, DB_USER і DB_PASSWORD.

Обережно

Інсталятор закріплює теги образів у .env (API_IMAGE_TAG, WORKER_IMAGE_TAG, UI_IMAGE_TAG). У .env, створеному з .env.dist, стоїть latest, і цей тег змінюється без вашого відома. Закріпіть теги на релізі.

Що далі

Домен і HTTPSРозмістіть інстанс на домені із сертифікатом.

КонфігураціяНалаштування, які треба визначити до запуску в роботу.

Швидкий стартНадішліть першу подію.