Skip to main content
This page walks through the fastest path to a working instance: Docker Compose on a server with a domain. For Kubernetes, ECS or another platform, see Other platforms. Heroku has its own guide.

​
Prerequisites

  • A server with Docker and Docker Compose
  • A domain name pointing at the server, with ports 80 and 443 open
  • A GitHub account that can create GitHub Apps
  • An Anthropic API key, or AWS credentials for Bedrock

​
Get started

1

Create the files

Make a folder with a docker-compose.yml, a Caddyfile and a .env. Copy them from Docker deployment.Generate the database password and the encryption key with:
2

Start Compiler

Database migrations run on startup. Open https://your-domain and sign up as the first user.
3

Connect GitHub

Setup asks for a GitHub App. Create one by following GitHub App setup, enter its App ID, slug and private key, then install it on the repositories Compiler may read.
4

Choose an AI provider

Pick the Anthropic API or AWS Bedrock and enter your credentials.
5

Create a project

Create your first project and choose the repositories it covers. Compiler clones them in the background, and you can start asking questions while they sync.

​
Next steps

Add file uploads

Let people attach images and documents to conversations.

Connect Slack

Answer questions directly in Slack threads.