repository·main·Indexed 25 days ago
https://github.com/dunglas/symfony-dockerA Docker-based installer and runtime for the Symfony web framework featuring FrankenPHP and Caddy. Designed for production, development, and CI environments, it includes support for Dev Containers, AI coding agents, and extensibility via Symfony Flex recipes for services like PostgreSQL, MySQL, Mercure, and Mailpit.
If you prefer to run your application over HTTP only instead of using HTTPS with Let's Encrypt, set the SERVER_NAME environment variable to :80 when starting your containers.
SERVER_NAME=:80 \
APP_SECRET=ChangeMe \
CADDY_MERCURE_JWT_SECRET=ChangeThisMercureHubJWTSecretKey \
docker compose -f compose.yaml -f compose.prod.yaml up --waitTo simplify common tasks, you can use a Makefile template in your project root. This template provides shortcuts for Docker, Composer, and Symfony commands.
Setup Instructions:
Makefile file at the root of your project.Makefile, as Makefiles are not compatible with spaces by default. You can enforce this in .editorconfig:[Makefile]
indent_style = tabRunning Make commands:
make.make command.makeTo integrate Symfony Docker into an existing project, follow these steps:
git archive to avoid overwriting your existing .git directory.extra.symfony.docker to true.symfony.lock file and force-install recipes to update Docker-related files based on your current packages.docker compose build and start the environment with docker compose up.XDEBUG_MODE environment variable to include debug (e.g., develop,debug).By default, docker compose up --wait only uses compose.yaml and compose.override.yaml. To properly build fresh images for a production environment using the production configuration, you must explicitly specify the compose files and use the --pull and --no-cache flags.
docker compose -f compose.yaml -f compose.prod.yaml build --pull --no-cacheBy default, Symfony Docker uses Debian-based FrankenPHP images, which is the recommended configuration. You can switch to Alpine-based images to achieve smaller image sizes, though they may be slower and have known issues.
To switch to Alpine, you must modify your Dockerfile to:
-alpine tag for the frankenphp_upstream stage./bin/bash to /bin/ash.apt-get commands with apk add --no-cache.frankenphp_prod base image to alpine:3.magic.mgc (from /usr/lib/file/ to /usr/share/misc/).-FROM dunglas/frankenphp:1-php8.5 AS frankenphp_upstream
+FROM dunglas/frankenphp:1-php8.5-alpine AS frankenphp_upstream
-SHELL ["/bin/bash", "-euxo", "pipefail", "-c"]
+SHELL ["/bin/ash", "-eux", "-o", "pipefail", "-c"]
-# hadolint ignore=DL3008
-RUN <<-EOF
- apt-get update
- apt-get install -y --no-install-recommends \
- file \
- git
+# hadolint ignore=DL3018
+RUN <<-EOF
+ apk add --no-cache \
+ file \
+ git
+ install-php-extensions \
-# hadolint ignore=DL3008,SC3054,DL4006
-RUN <<-'EOF'
- apt-get update
- apt-get install -y --no-install-recommends libtree
+# hadolint ignore=DL3018,SC3054,DL4006
+RUN <<-'EOF'
+ apk add --no-cache libtree
+ mkdir -p /tmp/libs
- BINARIES=(frankenphp php file)
- for target in $(printf '%s\n' "${BINARIES[@]}" | xargs -I{} which {}) \
+ BINARIES="frankenphp php file"
+ for target in $(printf '%s\n' $BINARIES | xargs -I{} which {}) \
- libtree -pv "$target" 2>/dev/null | grep -oP '(?:── )\K/\S+(?= \[)' | while IFS= read -r lib; do
+ libtree -pv "$target" 2>/dev/null | sed -n 's/.*── \(\/[^ ]*\) \[.*/\1/p' | while IFS= read -r lib; do
- rm -rf /var/lib/apt/lists/*
-FROM debian:13-slim AS frankenphp_prod
+FROM alpine:3 AS frankenphp_prod
-SHELL ["/bin/bash", "-euxo", "pipefail", "-c"]
+SHELL ["/bin/ash", "-eux", "-o", "pipefail", "-c"]
-COPY --from=frankenphp_prod_builder /usr/lib/file/magic.mgc /usr/lib/file/magic.mgc
+COPY --from=frankenphp_prod_builder /usr/share/misc/magic.mgc /usr/share/misc/magic.mgcTo deploy a Symfony application in production using Symfony Docker, you should use the production-optimized Docker Compose configuration. This process involves building a fresh image without cache and starting the containers with necessary environment variables like SERVER_NAME, APP_SECRET, and CADDY_MERCURE_JWT_SECRET.
Prerequisites:
A record pointing to your server's IP address (required for Let's Encrypt TLS certificates).Deployment Steps:
--pull and --no-cache flags to ensure you are using the latest base images and avoiding stale cache layers.docker compose command.# Build fresh production image
docker compose -f compose.yaml -f compose.prod.yaml build --pull --no-cache
# Start container
SERVER_NAME=your-domain-name.example.com \
APP_SECRET=ChangeMe \
CADDY_MERCURE_JWT_SECRET=ChangeThisMercureHubJWTSecretKey \
docker compose -f compose.yaml -f compose.prod.yaml up --waitTo install a non-stable version of Symfony, use the STABILITY environment variable during the build. The value must be a valid Composer stability option.
# Linux
STABILITY=dev docker compose up --wait
# Windows
set STABILITY=dev && docker compose up --wait&set STABILITY=By default, the certificates generated by the Caddy container are not trusted by your host machine. To avoid SSL/TLS warnings, you must copy the root certificate from the php container to your host's trust store.
Follow the command corresponding to your operating system.
### Linux
```console
docker cp $(docker compose ps -q php):/data/caddy/pki/authorities/local/root.crt /usr/local/share/ca-certificates/root.crt && sudo update-ca-certificatesdocker cp $(docker compose ps -q php):/data/caddy/pki/authorities/local/root.crt /tmp/root.crt && sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain /tmp/root.crtdocker compose cp php:/data/caddy/pki/authorities/local/root.crt %TEMP%/root.crt && certutil -addstore -f "ROOT" %TEMP%/root.crtAfter making the configuration changes, rebuild the environment and verify the connection works.
1. Rebuild the environment:
docker compose down --remove-orphans && docker compose build --pull --no-cache2. Start the services:
docker compose up --wait3. Test the connection: Run this command to verify the database is reachable via Doctrine:
docker compose exec php bin/console dbal:run-sql -q "SELECT 1" && echo "OK" || echo "Connection is not working"docker compose down --remove-orphans && docker compose build --pull --no-cache
docker compose up --wait
docker compose exec php bin/console dbal:run-sql -q "SELECT 1" && echo "OK" || echo "Connection is not working"To run the project using HTTP instead of HTTPS, set the SERVER_NAME and MERCURE_PUBLIC_URL environment variables to use the http:// scheme and start the containers.
SERVER_NAME=http://localhost \
MERCURE_PUBLIC_URL=http://localhost/.well-known/mercure \
docker compose up --wait