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
POSTGRES_USER	string	The username for the PostgreSQL database.	postgres
POSTGRES_PASSWORD	string	The password for the PostgreSQL database.	postgres
POSTGRES_DB	string	The name of the PostgreSQL database.	keycloak
TLS_CERT	string	The path to the TLS certificate file.	/etc/ssl/certs/tls.crt
TLS_KEY	string	The path to the TLS key file.	/etc/ssl/private/tls.key
KEYCLOAK_URL	string	The URL for Keycloak. E.g. https://keycloak.example.com (Required)
KC_ADMIN_USER	string	The admin username for Keycloak. (Required)
KC_ADMIN_PASSWORD	string	The admin password for Keycloak. (Required)
REALM_INSTALLER_CLIENT_SECRET	string	The secret for the realm installer client for Keycloak. (Required)
KEYCLOAK_REALM	string	The realm for Keycloak.	eggplant
INITIAL_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.