Docker Compose Environment Variables
These are the environment variables that can be added to a .env file which should be created in the same directory as the docker-compose.yaml file to configure the installation. The default values are shown in the table below.
| Key | Type | Description | Default |
|---|---|---|---|
| GENERATOR_URL | string | The URL for the generator application. (Required) | |
| GENERATOR_PORT | string | The port for the generator application. | 8443 |
| KC_ADMIN_USER | string | The admin username for Keycloak. This must match what was set when installing Keycloak. (Required) | |
| KC_ADMIN_PASSWORD | string | The admin password for Keycloak. This must match what was set when installing Keycloak. (Required) | |
| REALM_INSTALLER_CLIENT_SECRET | string | The secret for the realm installer client for Keycloak. This must match during this initial installation. (Required) | |
| KEYCLOAK_BASE_URL | string | The base URL for Keycloak. (Required) | |
| KEYCLOAK_FRONTEND_URL | string | The realm for Keycloak. | eggplant |
| POSTGRES_USER | string | The username for the PostgreSQL database. | postgres |
| POSTGRES_PASSWORD | string | The password for the PostgreSQL database. (Required) | eggplant |
| POSTGRES_DB | string | The name of the PostgreSQL database. | eggplant_skill |
| NEO4J_USERNAME | string | The username for the Neo4j database. | neo4j |
| NEO4J_PASSWORD | string | The password for the Neo4j database. | eggplant |
| MAX_FILE_UPLOAD_SIZE | string | The maximum file upload size in megabytes. | 10m |
| IINITIAL_USER_USERNAME | string | The username for the initial Keycloak user. (Required) | |
| INITIAL_USER_PASSWORD | string | The password for the initial Keycloak user. (Required) | |
| INITIAL_USER_GIVEN_NAME | string | The given name for the initial Keycloak user. (Required) | |
| INITIAL_USER_FAMILY_NAME | string | The family name for the initial Keycloak user. (Required) | |
| INITIAL_USER_EMAIL | string | The email for the initial Keycloak user. (Required) | |
| INITIAL_USER_IS_PASSWORD_TEMPORARY | boolean | Whether the initial user's password is temporary. | true |
| SMTP_HOST | string | The SMTP server host. | localhost |
| SMTP_PORT | integer | The SMTP server port. | 25 |
| SMTP_FROM | string | The "from" address for SMTP emails. | noreply@localhost |
| SMTP_AUTH | boolean | Whether SMTP authentication is enabled. | true |
| SMTP_USERNAME | string | The username for SMTP authentication. | |
| SMTP_PASSWORD | string | The password for SMTP authentication. |
Important
Set POSTGRES_PASSWORD in your .env file so it is passed to both the database and the application containers. If you omit it, Docker Compose falls back to the default (eggplant), which is not recommended for production deployments.