Environment configuration

Marketix is configured entirely through environment variables. Start by copying .env.example to .env, then work through the groups below. Variables used only in Docker Compose deployments are read from .env by Docker and passed into the containers — they are not loaded from the filesystem inside the container.

For a complete, searchable table of every variable, see Environment variables reference.

Application identity (APP_*)

APP_NAME=Laravel
APP_ENV=production
APP_KEY=
APP_DEBUG=false
APP_URL=https://app.example.com
APP_DOMAIN=app.example.com
APP_LOCALE=en
APP_FALLBACK_LOCALE=en

Variable	Description
APP_NAME	Display name of the application. Passed to the frontend as VITE_APP_NAME. Used in email subjects and branding.
APP_ENV	Set to production on live deployments. Controls debug output and error handling.
APP_KEY	32-byte application encryption key. Generate with php artisan key:generate. Required and must be kept secret.
APP_DEBUG	Set to false in production. true exposes stack traces in error responses.
APP_URL	Full URL of the application including scheme (e.g. https://app.example.com). Used to generate absolute URLs in emails and redirects.
APP_DOMAIN	Hostname only, without scheme (e.g. app.example.com). Used by the route group for the main application and by Traefik’s Host() rule. Must match your DNS A record.
APP_LOCALE	Default locale for the application UI (e.g. en, de).
APP_FALLBACK_LOCALE	Fallback locale when a translation key is missing.

Caution

APP_DOMAIN must not include https:// — it is the bare hostname. APP_URL must include the scheme. Both must be consistent with your Traefik and DNS configuration.

Database (DB_*)

DB_CONNECTION=mariadb
DB_HOST=db
DB_PORT=3306
DB_DATABASE=db
DB_USERNAME=db
DB_PASSWORD=db

Variable	Description
DB_CONNECTION	Driver: mariadb for production (Docker Compose default), sqlite for local development.
DB_HOST	Database server hostname. Use db when running inside the provided Compose stack.
DB_PORT	Database port. Default MariaDB port is 3306.
DB_DATABASE	Database name.
DB_USERNAME	Database user.
DB_PASSWORD	Database password.

Note

In the Docker Compose stack, the database credentials are set to db / db / db for the application user inside the Compose file. You only need to set MYSQL_ROOT_PASSWORD in your .env — see the Docker credentials section below.

Session, cache, and queue

SESSION_DRIVER=database
SESSION_LIFETIME=120
CACHE_STORE=database
QUEUE_CONNECTION=redis

Variable	Description
SESSION_DRIVER	Where sessions are stored. database is the default. Can be changed to redis for better performance.
SESSION_LIFETIME	Session lifetime in minutes.
CACHE_STORE	Cache backend. database by default. Change to redis for production under load.
QUEUE_CONNECTION	Queue backend. Must be redis for Horizon to work. The default in .env.example is database; the Docker Compose stack overrides this to redis.

Redis (REDIS_*)

REDIS_CLIENT=phpredis
REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379

Variable	Description
REDIS_CLIENT	PHP Redis client library. phpredis (C extension) is the default and is installed in the Docker image.
REDIS_HOST	Redis server hostname. Use redis inside the Docker Compose stack.
REDIS_PASSWORD	Redis authentication password. Set to a strong value in production. Must match REDIS_PASSWORD in the Docker Compose credentials section.
REDIS_PORT	Redis port. Default is 6379.

Mail (MAIL_*)

MAIL_MAILER=smtp
MAIL_HOST=smtp.example.com
MAIL_PORT=587
MAIL_USERNAME=
MAIL_PASSWORD=
MAIL_FROM_ADDRESS="hello@example.com"
MAIL_FROM_NAME="${APP_NAME}"

Variable	Description
MAIL_MAILER	Transport driver. Use smtp for standard SMTP, log for development (writes to log file).
MAIL_HOST	SMTP server address.
MAIL_PORT	SMTP port (typically 587 for STARTTLS or 465 for SSL).
MAIL_USERNAME	SMTP username.
MAIL_PASSWORD	SMTP password.
MAIL_FROM_ADDRESS	Envelope sender address. Must be a valid address accepted by your SMTP provider.
MAIL_FROM_NAME	Sender display name shown in mail clients.

Mail is required for team invitations and password reset emails.

Object storage (AWS_*)

FILESYSTEM_DISK=local
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=
AWS_USE_PATH_STYLE_ENDPOINT=false

Variable	Description
FILESYSTEM_DISK	local stores files in storage/app. s3 uses the S3-compatible provider configured below.
AWS_ACCESS_KEY_ID	S3 access key.
AWS_SECRET_ACCESS_KEY	S3 secret key.
AWS_DEFAULT_REGION	Bucket region.
AWS_BUCKET	Bucket name.
AWS_USE_PATH_STYLE_ENDPOINT	Set true for MinIO and other path-style-endpoint providers.

Octane server

OCTANE_SERVER=frankenphp

The official Docker image is built with FrankenPHP. This variable must stay frankenphp when using the provided Dockerfile and Compose stack. The Compose file sets this value and ignores whatever is in the host .env — only relevant if you run Octane outside Docker.

Frontend branding

VITE_APP_NAME="${APP_NAME}"

VITE_APP_NAME is embedded into the compiled frontend bundle at build time. In the Docker image it is set to marketix. If you build your own image, override this variable before running npm run build.

Docker Compose credentials

These variables are read by docker-compose.yml on the host (not inside containers) for service bootstrapping.

LETSENCRYPT_EMAIL=admin@example.com
MYSQL_ROOT_PASSWORD=change-me-strong-password
REDIS_PASSWORD=change-me-strong-password
TRAEFIK_DYNAMIC_FILE=/traefik/custom-domains.yml
TRAEFIK_APP_URL=http://app:8000

Variable	Description
LETSENCRYPT_EMAIL	Email address passed to the Let’s Encrypt ACME server when registering the TLS account. Required for Traefik to obtain certificates.
MYSQL_ROOT_PASSWORD	MariaDB root password. Set a strong, unique value — this is the superuser credential for the database service.
REDIS_PASSWORD	Password passed to both the Redis redis-server --requirepass command and the application’s REDIS_PASSWORD. Must be identical in both places.
TRAEFIK_DYNAMIC_FILE	Path inside the container where the app writes the Traefik file-provider YAML. Default is /traefik/custom-domains.yml — do not change unless you also modify the Compose volume mounts.
TRAEFIK_APP_URL	Internal URL of the app container as seen by Traefik. Default is http://app:8000. Do not change unless you rename the service.

Danger

Never commit .env to version control. It contains your APP_KEY, database credentials, and SMTP password. Store it outside the repository and inject it via your deployment tooling.