Skip to main content

Deploy

Deploy with Docker Compose​

Ensure you have Docker and Docker Compose installed on your machine.

Sync the compose files to your machine​

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

compose.yml contains the base configuration; compose.env contains variables you should edit.


Edit the variables in compose.env​

For a quick demo the compose files work out of the box. For production, edit the variables in compose.env to suit your environment.

It's strongly recommended to change the default passwords and to configure email settings for account verification and password recovery. See Configuration for details.

Deploy​

Run the following command to start the services in detached mode:

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

Access​

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

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