Installation
Prerequisites
Section titled “Prerequisites”- Node.js 20+
- Docker & Docker Compose
- npm
Clone the repository
Section titled “Clone the repository”git clone https://github.com/pascalwilbrink/kairosis.gitcd kairosisStart infrastructure
Section titled “Start infrastructure”Kairosis requires PostgreSQL and RabbitMQ. Start them with Docker Compose:
docker compose up -dThis starts:
- PostgreSQL 16 on port
5432 - RabbitMQ on port
5672(management UI on15672)
Install dependencies
Section titled “Install dependencies”npm installConfigure environment
Section titled “Configure environment”Copy the example env file and fill in the required values:
cp .env.example .envKey variables:
POSTGRES_HOST=localhostPOSTGRES_PORT=5432POSTGRES_DB=kairosisPOSTGRES_USER=kairosisPOSTGRES_PASSWORD=kairosis_dev
RABBITMQ_URL=amqp://kairosis:kairosis_dev@localhost:5672RABBITMQ_EXCHANGE=kairosis.topic
# Generate with: openssl rand -hex 32ENCRYPTION_KEY=your_32_byte_hex_key
API_PUBLIC_URL=http://localhost:3200NEXT_PUBLIC_API_URL=http://localhost:3200Start the application
Section titled “Start the application”npm run devThis starts:
- API on http://localhost:3200
- Dashboard on http://localhost:3001
- Poller worker in the background
First-run setup
Section titled “First-run setup”Open the dashboard at http://localhost:3001. You’ll be redirected to the setup wizard (/setup) to create your first workspace.
Once setup is complete, you’re ready to configure connectors and receive events.
Next steps
Section titled “Next steps”- Quick Start — configure a connector and receive your first event