Quick Start
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
- Git
- Docker Engine >= 19.03.0
- Kubernetes cluster (Optional. Required for connectors syncs)
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
Please see Production Deployment for the reference of all variables.
Name | Default value | Description |
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_URL | Optional 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.: |
JITSU_INGEST_PUBLIC_URL | Optional 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.: |
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:
- Set up Connectors Syncs.
- Set
DISABLE_SIGNUP
in.env
totrue
if you don't want to allow users to sign up. - See reference for other variables in Production Deployment guide.