environment-variables.md

Setting up your environment variables

Environment variables for your environment are contained in .env.local. If you don't have an .env.local file yet, go ahead and create one.

To get started, look at the contents of .env: this template contains all of the default values for the application. Any environment variable you haven't re-defined in your .env.local file will take its value in the .env file (if it is defined there).

Here is a detailed list of all the environment variables, why they are needed, and how you should define them.

Required variables

Name	Purpose	How to set it up
APP_ENV	Symfony configuration	Usually prod or dev (learn more on Symfony's documentation)
APP_SECRET	Symfony configuration	Random hash used for CSRF token generation.
MAILER_DSN	Symfony configuration	https://symfony.com/doc/current/mailer.html#transport-setup
MESSENGER_TRANSPORT_DSN	Symfony configuration	https://symfony.com/doc/current/messenger.html#transports-async-queued-messages
SYMFONY_VERSION	Docker configuration	Defines the version of Symfony to use on a fresh install (use the latest stable version)
SERVER_NAME	Caddy configuration	Domain configuration for the web server (first line of Caddyfile)
DATABASE_URL	Database (Symfony configuration)	https://symfony.com/doc/current/doctrine.html#configuring-the-database
REDIS_HOST	PHP sessions	Hostname for the Redis database
REDIS_PASSWORD	PHP sessions	Redis password
REDIS_PORT	PHP sessions	Redis port
KOALATI_RELEASE_VERSION	Release tracking & asset versioning	Enter the current release version of the app (or a random string for local development)
MAILER_FROM_ADDRESS	Email delivery	Enter the email address to use as the FROM address for all emails sent by Koalati
MERCURE_URL	Real-time client-server updates	https://symfony.com/doc/current/mercure.html#configuration (corresponds to MERCURE_URL)
MERCURE_PUBLIC_URL	Real-time client-server updates	https://symfony.com/doc/current/mercure.html#configuration (corresponds to MERCURE_PUBLIC_URL)
MERCURE_JWT_SECRET	Real-time client-server updates	https://symfony.com/doc/current/mercure.html#configuration (corresponds to MERCURE_JWT_SECRET)
STORAGE_REGION	Storage of user-generated media	Configure with any S3-standardized hosting service (Amazon S3, DigitalOcean Spaces, etc.)
STORAGE_VERSION	Storage of user-generated media	Configure with any S3-standardized hosting service (Amazon S3, DigitalOcean Spaces, etc.)
STORAGE_AUTH_KEY	Storage of user-generated media	Configure with any S3-standardized hosting service (Amazon S3, DigitalOcean Spaces, etc.)
STORAGE_AUTH_SECRET	Storage of user-generated media	Configure with any S3-standardized hosting service (Amazon S3, DigitalOcean Spaces, etc.)
STORAGE_BUCKET	Storage of user-generated media	Configure with any S3-standardized hosting service (Amazon S3, DigitalOcean Spaces, etc.)
STORAGE_ENDPOINT	Storage of user-generated media	Configure with any S3-standardized hosting service (Amazon S3, DigitalOcean Spaces, etc.)
STORAGE_CDN_URL	Storage of user-generated media	Configure with any S3-standardized hosting service (Amazon S3, DigitalOcean Spaces, etc.)
TOOLS_API_WORKER_URL	Tools service API (recommendations)	Define the URL at which the tools service API is reachable (including the port, if not 80/443)
TOOLS_API_WORKER_BEARER_TOKEN	Tools service API (recommendations)	https://github.com/koalatiapp/tools-service#authentication
APIFLASH_ACCESS_KEY	Project screenshot	Create an account on API FLASH and enter your access key here.
OPENGRAPHIO_API_KEY	URL previews	Create an account on OpenGraph.io and enter your API key here.
URLMETA_ACCOUNT_EMAIL	URL previews	Create an account on URL Meta and enter your account's email here.
URLMETA_API_KEY	URL previews	Create an account on URL Meta and enter your API key here.

Optional variables

Name	Purpose	How to set it up
TOOLS_API_FUNCTIONS_URL	Tools service API (recommendations)	Define the URL at which the tool service serverless functions, which may be used to lighten the load on the worker(s), are reachable.
TOOLS_API_FUNCTIONS_BEARER_TOKEN	Tools service API (recommendations)	https://github.com/koalatiapp/tools-service-functions
FAVICONKIT_API_HOSTNAME	Favicon fetching	Create an account on FaviconKit and enter your custom hostname here.

Production specific

Name	Purpose	How to set it up
SENTRY_DSN	Error tracking	Create an account on Sentry.io and enter the DSN.

Development specific

Name	Purpose	How to set it up
MYSQL_HOST	Database (Docker config)	Hostname for the MySQL database
MYSQL_USER	Database (Docker config)	MySQL username
MYSQL_PASSWORD	Database (Docker config)	MySQL password
MYSQL_DATABASE	Database (Docker config)	MySQL database
MYSQL_PORT	Database (Docker config)	MySQL port
MYSQL_VERSION	Database (Docker config)	MySQL server version
ADMINER_PORT	Database management (Docker config)	Port on which Adminer should run
TOOLS_API_JWT_SECRET	Tool service configuration	Corresponds to JWT_SECRET
TOOLS_API_AUTH_ACCESS_TOKEN	Tool service configuration	Corresponds to AUTH_ACCESS_TOKEN
TOOLS_API_DATABASE_HOST	Tool service configuration	Corresponds to DATABASE_HOST
TOOLS_API_DATABASE_USER	Tool service configuration	Corresponds to DATABASE_USER
TOOLS_API_DATABASE_PASSWORD	Tool service configuration	Corresponds to DATABASE_PASSWORD
TOOLS_API_DATABASE_NAME	Tool service configuration	Corresponds to DATABASE_NAME