Skip to main content

Deploy

Deploy with Docker Compose​

Budget Board uses Docker for deployment. Ensure you have Docker and Docker Compose installed on your machine before proceeding.

Download the Compose Files​

There are two files needed to deploy the app:

  • compose.yml: This file contains the base configuration, and should not be edited.
  • compose.env: This file contains environment variables that can be customized for your deployment.

On macOS or Linux, you can download the compose files with:

curl -O https://raw.githubusercontent.com/teelur/budget-board/refs/heads/main/compose.yml && curl -O https://raw.githubusercontent.com/teelur/budget-board/refs/heads/main/compose.env

On Windows (PowerShell), use:

Invoke-WebRequest -OutFile compose.yml https://raw.githubusercontent.com/teelur/budget-board/refs/heads/main/compose.yml; Invoke-WebRequest -OutFile compose.env https://raw.githubusercontent.com/teelur/budget-board/refs/heads/main/compose.env

Edit the Variables in compose.env​

If you are just testing the app, the compose files will deploy without any changes.

For production, it is strongly recommended to edit the variables in compose.env to suit your environment. At a minimum, you should update the following variables:

  • POSTGRES_PASSWORD: Change this to a strong password for the PostgreSQL database.
  • Email Sender Configuration: If you don't plan on using OIDC for authentication, it is highly recommended to set up an email sender for account confirmation and password resets. If you don't set this up, you will have no way of resetting your password if you forget it.

See the Configuration page for more details.

Deploy Budget Board​

Run the following command to deploy the app:

docker compose --env-file compose.env up -d

Access Budget Board​

You can access the app by navigating to the following URL in your browser:

http://{machine-ip-address}:6253