Quick Start

Get pipel8ne running locally in under 5 minutes using Docker Compose.

Prerequisites

• Docker Desktop (includes Docker Compose)
• A terminal

Step 1 — Clone the repository

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

Step 2 — Create your environment file

Create a .env file at the root of the project:

cp .env.example .env

Then open .env and fill in two required values:

JWT_SECRET=<generate below>
SECRETS_ENCRYPTION_KEY=<generate below>

Generate secure values with Node.js:

# JWT_SECRET — paste the output into .env
node -e "console.log(require('crypto').randomBytes(64).toString('hex'))"

# SECRETS_ENCRYPTION_KEY — must be exactly 64 hex characters (32 bytes)
node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"

WARNING

Never commit .env to version control. These secrets protect your users' data.

Step 3 — Start the stack

docker compose up

Docker will pull the images, start MongoDB, and launch the backend. Wait until you see:

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

Step 4 — Create your account

Open your browser and go to http://localhost:3000.

You will be prompted to register. Fill in your name, email, and password — this first account becomes the administrator.

TIP

After creating your account, head to Settings → Administration to disable public registration if you don't want others to sign up.

Step 5 — Create your first pipeline

1. Click New Project and give it a name
2. Open the project and click New Pipeline
3. Click anywhere on the canvas to add your first stage

You're ready to build. Continue with the user guide for a full walkthrough.

---

What's running

Service	URL	Description
Frontend + API	http://localhost:3000	The pipel8ne app
MongoDB	localhost:27017	Database (internal, not exposed by default)

Stopping the stack

docker compose down

To also delete all data (MongoDB volume):

docker compose down -v

Updating

git pull
docker compose pull
docker compose up -d