Get Started

Prerequisites

Before deploying, make sure you have:

• a Linux VPS with Docker Engine and Docker Compose installed
• a domain you can point to your server
• access to create DNS records
• access to clone this repository on your server

For production usage, use a reverse proxy with HTTPS termination in front of the app container.

Installation flow

From the project root on your server:

chmod +x scripts/selfhost-setup.sh
./scripts/selfhost-setup.sh

The setup script is expected to:

1. Validate required inputs and environment values.
2. Prepare .env from .env.selfhost.example if it does not exist.
3. Build and start the stack with Docker Compose.

If you need to adjust configuration values, update your .env file and re-run the setup script.

Initial startup checks

After setup, verify the containers are running:

docker compose ps

Then follow the application logs until the app reports it is ready:

docker compose logs -f app

For database diagnostics:

docker compose logs -f postgres

First login and signup

Once the app is reachable in the browser:

1. Open your configured domain.
2. Create your first account or sign in.
3. Complete onboarding and initial company setup.

After this first login, continue with Managing Your Installation to handle updates, restarts, and troubleshooting workflows.