Skip to content

Quick start

Balnana is one server process and a PostgreSQL database. The repository ships a Docker Compose file that runs both, with the web app built in.

  1. Create your settings file from the example:

    Terminal window
    cp .env.example .env
  2. Open .env and set at least POSTGRES_PASSWORD. A long random value works well:

    Terminal window
    openssl rand -hex 24

    Avoid $ in the password, since Compose reads it as a variable, or write it as $$.

  3. Build and start everything:

    Terminal window
    docker compose up -d --build

    Database migrations run automatically on startup.

  4. Open http://localhost:8080. Change the port with BALNANA_PORT in .env.

The first time anyone opens a new server, the app sends them to /admin to choose the administrator password. Do this straight after starting the server.

You will also need the setup code from the server log. This prevents another visitor from setting the password before you do. To find the code, run:

Terminal window
docker compose logs balnana