Skip to main content

Quick Start

info

This guide uses docker-compose to run Jitsu locally. It's suitable for testing purposes only, and it servers as a reference implementation to demonstrate how Jitsu components interact with each other. For production deployments, please see Production Deployment guide.

Requirements

Step 1: Clone the repository

# Clone the repository
git clone -b newjitsu --single-branch --depth 1 https://github.com/jitsucom/jitsu
cd jitsu/docker
# Copy .env.example to .env
cp .env.example .env

Step 2: Edit .env file

note

Please see Production Deployment for the reference of all variables.

NameDefault valueDescription
SEED_USER_EMAIL
SEED_USER_PASSWORD
Required

Initial user login and password. The very first user will be created with those credentials, and it will become an admin user. Please change the password right after first login.

GITHUB_CLIENT_ID
GITHUB_CLIENT_SECRET
Optional

Use github instead password auth or in addition to it if you want several users to access Jitsu UI.

JITSU_PUBLIC_URLOptional
Default: http://localhost:3000

This is a URL where Jitsu UI will be available. When UI is deployed on remote server, set it with your remote server URL, e.g.: http://your-domain:3000. For production deployments, it is recommended to put it behind an HTTPs load balancer or reverse proxy. In this case, this value must be set to a public URL, such as: https://jitsu.my-company.com.

JITSU_INGEST_PUBLIC_URLOptional
Default: http://localhost:8080

This is a URL where Jitsu Ingest will be available. When Jitsu is deployed on remote server, set it with your remote server URL, e.g.: http://your-domain:8080. For production deployments, it is recommended to put it behind an HTTPs load balancer or reverse proxy. In this case, this value must be set to a public URL, such as: https://jitsu.my-company.com.

CONSOLE_TOKEN
POSTGRES_PASSWORD
BULKER_TOKEN
SYNCCTL_TOKEN
Required

Those secrets are used mostly for internal communication between Jitsu components. Please make sure to generate random values for those variables.

Run Jitsu

In jitsu/docker directory run:

docker-compose up

Open Jitsu URL (e.g.: http://localhost:3000/) in your browser, login with the credentials you've set in .env or with GitHub if you've set GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET variables. See data ingestion instructions right in the UI.

Further steps

Those steps are optional, but they might make sense for you: