Skip to content

Быстрый старт

Запустите pipel8ne локально менее чем за 5 минут с помощью Docker Compose.

Предварительные требования

Шаг 1 — Клонировать репозиторий

bash
git clone https://github.com/ogb4n/pipel8ne.git
cd pipel8ne

Шаг 2 — Создать файл окружения

Создайте файл .env в корне проекта:

bash
cp .env.example .env

Откройте .env и заполните два обязательных значения:

env
JWT_SECRET=<сгенерировать ниже>
SECRETS_ENCRYPTION_KEY=<сгенерировать ниже>

Сгенерируйте безопасные значения с помощью Node.js:

bash
# JWT_SECRET — вставьте результат в .env
node -e "console.log(require('crypto').randomBytes(64).toString('hex'))"

# SECRETS_ENCRYPTION_KEY — ровно 64 шестнадцатеричных символа (32 байта)
node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"

WARNING

Никогда не коммитьте .env в систему контроля версий. Эти секреты защищают данные ваших пользователей.

Шаг 3 — Запустить стек

bash
docker compose up

Docker загрузит образы, запустит MongoDB и бэкенд. Дождитесь строки:

pipel8ne-backend  | Server listening on http://0.0.0.0:3000

Шаг 4 — Создать аккаунт

Откройте браузер и перейдите по адресу http://localhost:3000.

Вас попросят зарегистрироваться. Введите имя, email и пароль — первый аккаунт становится администратором.

TIP

После создания аккаунта перейдите в Настройки → Администрирование и отключите публичную регистрацию, если не хотите, чтобы другие могли зарегистрироваться.

Шаг 5 — Создать первый пайплайн

  1. Нажмите Новый проект и задайте ему имя
  2. Откройте проект и нажмите Новый пайплайн
  3. Кликните на холсте, чтобы добавить первый стейдж

Вы готовы к работе. Продолжайте с руководства пользователя для полного прохождения.


Что запущено

СервисURLОписание
Фронтенд + APIhttp://localhost:3000Приложение pipel8ne
MongoDBlocalhost:27017База данных (внутренняя, по умолчанию не открыта)

Остановка стека

bash
docker compose down

Чтобы также удалить все данные (том MongoDB):

bash
docker compose down -v

Обновление

bash
git pull
docker compose pull
docker compose up -d

Released under the MIT License.