Getting-started
Configuring your application
Pledger.io uses environment variables to configure the application.
General configuration options
| Variable | Description | Default |
|---|---|---|
DB_TYPE | The type of database to use, allowed are h2 or mysql | h2 |
MICRONAUT_ENVIRONMENTS | Comma-separated Micronaut environment profiles, for example h2,jpa or mysql,jpa. The Docker image normally sets this for you based on DB_TYPE. | - |
MICRONAUT_APPLICATION_STORAGE_LOCATION | Directory used for uploaded and generated files. Mount a volume here to keep data across container restarts. | JVM temp directory |
Note
The backend also ships a PostgreSQL profile (
psql). Advanced setups can activate it directly withMICRONAUT_ENVIRONMENTS=jpa,psqlinstead of usingDB_TYPE.
MySQL configuration options
If the database type is set to mysql then the following environment variables are used.
| Variable | Description | Default |
|---|---|---|
DATABASE_HOST | The MySQL server host | localhost |
DATABASE_PORT | The MySQL server port | 3306 |
DATABASE_SCHEMA | The MySQL schema to use | fintrack |
DATABASE_USER | The MySQL user for authentication | fintrack |
DATABASE_PASSWORD | The MySQL password for authentication | fintrack |
Mail configuration options
Mail is disabled by default (a mock mail sender is used).
To enable real mail delivery, activate the smtp environment profile, for example
MICRONAUT_ENVIRONMENTS=h2,jpa,smtp, and configure the following variables.
| Variable | Description | Default |
|---|---|---|
SMTP_HOST | The SMTP server host | - |
SMTP_USER | The SMTP user for authentication | - |
SMTP_PASSWORD | The SMTP password for authentication | - |
The connection uses port 587 with STARTTLS.
OpenID configuration options
When you want to enable OpenID connect in Pledger.io you will have to configure the following settings.
| Variable | Description | Default |
|---|---|---|
OPENID_URI | The URI to the certificate location for the Realm in OpenID | - |
OPENID_SECRET | The secret for the client | - |
OPENID_AUTHORITY | The URI to the realm | - |
OPENID_CLIENT | The client identifier | pledger-io |
Large Language Model options
When either using the docker image ghcr.io/pledger-io/amd64-embedded-llm you can configure the following options.
Alternatively you can use the normal image but use
OpenAI, at the cost of some privacy.
| Variable | Description | Default |
|---|---|---|
AI_ENGINE | The engine to use. Supported are ollama and open-ai | ollama |
AI_MODEL | The Ollama model to use, only used with AI_ENGINE ollama | qwen3:4b |
AI_TEMPERATURE | Controls the creativity of the model, between 0 (predictable) and 1 (creative) | 0.7 |
APPLICATION_AI_OLLAMA_URI | The URI of the Ollama server, only used with AI_ENGINE ollama | http://localhost:11434 |
OPENAI_TOKEN | The application token for OpenAI, must be set when AI_ENGINE is open-ai | - |