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.
What you need
Section titled “What you need”- A machine with Docker and the Compose plugin.
- A copy of the Balnana repository.
Start the server
Section titled “Start the server”-
Create your settings file from the example:
Terminal window cp .env.example .env -
Open
.envand set at leastPOSTGRES_PASSWORD. A long random value works well:Terminal window openssl rand -hex 24Avoid
$in the password, since Compose reads it as a variable, or write it as$$. -
Build and start everything:
Terminal window docker compose up -d --buildDatabase migrations run automatically on startup.
-
Open
http://localhost:8080. Change the port withBALNANA_PORTin.env.
Set the administrator password
Section titled “Set the administrator password”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:
docker compose logs balnanaNext steps
Section titled “Next steps”- To connect from other devices, set up a reverse proxy.
- Choose between link mode and accounts.
- Connect the Android app to your server.