This setup helps operation teams to setup TruBudget in an easy way with a pre-configured .env file.
To setup TruBudget, you need to install Docker (version 20.10.7 or higher) and Docker Compose (version 1.29.2 or higher). If you use Docker Desktop, you need to expose a shared folder for /alphaNode in Preferences/Resources/File Sharing in order to store the local blockchain.
First, to make sure the .env file is set, run bash env-vars-generator.sh that will guid you through variables creation. Alternatively you can run cp env.example .env and copy example file and then manually update .env file.
To start the slim setup (only blockchain, api, frontend), run bash start-trubudget.sh or bash start-trubudget.sh --slim.
To start 2 slim TruBudget instances for 2 organizations, run bash start-trubudget.sh --slim --add-organization.
To start the full setup, run bash start-trubudget.sh --full.
For further information, run bash start-trubudget.sh --help.
When the setup has completed, you can open these URLs in the browser:
Frontend: http://localhost:3000/
API: http://localhost:8080/api/documentation/static/index.html
If the Trubudget has started without provisioning, only available user will be the root. The root user credentials are (by default):
Username | Password
------------------------
root | root-secret
Default password for the root user can be changed via the environment variable ROOT_SECRET under .env file.
To learn how to setup TruBudget with multiple organizations and how tho connect them, see the documentation of Connect to an existing network
The environmental variables are located in the file .env (in the directory scripts/operation/). You can change them directly. If you do not have an .env file, you can copy the .env.example file.
| Options | Description |
|---|---|
| --slim | Starts a TruBudget instance with alpha-node, alpha-api and frontend. |
| --full | Starts a TruBudget instance with alpha-node, emaildb, minio, alpha-api, email-service, provisioning, excel-export-service, storage and frontend. |
| --enable-service [services...] | Starts additional services to the TruBudget instance. Available services: email-service, excel-export-service, storage-service |
| --no-log | Disable logs of all docker-containers |
| --provision | Start the provisioning |
| --add-beta | Add a beta-node that tries to connect to alpha-node |
| --add-organization | Add a beta-node, beta-api, beta-frontend from a new Organization. Needs to be approved by alpha-node |
| --prune | Delete the multichain, document storage and email database (docker volume) |
| --down | Shutdown all docker containers |
| --help | Print the help section |
If you want to start the application provisioned with your own data, and you know what you are doing, use start-provision.sh.
This script rebuilds the provisioning image, and uses most of the options above. Please read the documentation of Provisioning