Installation

Installation

⚠️ BudgetMaster no longer uses a H2 database to store your data.
❗ Starting with BudgetMaster v2.10.0 a PostgreSQL backend is used. Therefore a postgres database must be provided. ❗
You can either provide one by yourself or use docker-compose.

If you used BudgetMaster before v2.10.0 a migration helper is automatically opened upon first start of BudgetMaster v2.10.0. This helper allows you to completly migrate your existing data from your H2 database to the PostgreSQL database. Your originally H2 database remains untoched and in place in case you need it again.

❗ BudgetMaster v2.11.0 ist the last release providing the automatic database migrator ❗

Run from command line

1. Create a new empty postgres database

2. Start the BudgetMaster executable

The start will fail but don't panic! This is intended because we have not provided a valid settings file yet. BudgetMaster will automatically create a default settings file on first start.

3. Prepare general settings

• Navigate to your_home_directory/Deadlocker/BudgetMaster/
• Open the file settings.properties with your default text editor
• Fill in the database settings
• Change the server port if you want
• Get an SSL certificate
• Fill in the SSL settings
  • <path_to_keystore> needs to be replaced with the path to the *.p12-file created in the previous step (The path can be relative to the location of the BudgetMaster executable or as absolute.)
  • <keystore_password> needs to be replaced with the password you specified for the *.p12-file
  • <keystore_alias> needs to be replaced with the alias you specified in the *.p12-file (specified by the -name option)
• Further information about all command line options and settings

4. Start the BudgetMaster executable

Login with the default Password BudgetMaster

5. Setup BudgetMaster

• Switch to the settings page
• Immediately change your password so that it no longer equals the default one
• Choose your additional settings

6. DONE!

Run with docker-compose

1 Build the docker image

• Check out the BudgetMaster repository
• Switch to th repo folder
• Compile the project mvn package -U -f pom.xml
• Build the image with the following command: docker build . -t deadlocker8/budgetmaster:latest --pull

2. Prepare general settings in docker-compose.yaml

• Open the file docker-compose.yaml with your default text editor
• Adjust the settings of the BudgetMaster container to your needs (e.g. the volume mount destinations)
• Get an SSL certificate and enable SSL (highly recommended!)
  • Add the SSL settings to environment section of the BudgetMaster container inside the docker-compose.yaml
    • Set security.require-ssl to true
    • server.ssl.key-store needs to point to the path to the *.p12-file created in the previous step (The path can be relative to the location of the BudgetMaster executable or as absolute.)
    • server.ssl.key-store needs to be set to the password you specified for the *.p12-file
    • server.ssl.keyAlias needs to be set to the alias you specified in the *.p12-file (specified by the -name option)
  • Further information about all command line options and settings

3. Start BudgetMaster via docker-compose

Use docker-compose up -d to start.
Login with the default Password BudgetMaster

4. Setup BudgetMaster

• Switch to the settings page
• Immediately change your password so that it no longer equals the default one
• Choose your additional settings

5. DONE!