2022-11-03 09:04:29 +01:00
# Building Custom Docker Image
2022-10-21 16:23:23 +03:00
2024-03-04 16:36:40 -05:00
[FrankenPHP Docker images ](https://hub.docker.com/r/dunglas/frankenphp ) are based on [official PHP images ](https://hub.docker.com/_/php/ ). Debian and Alpine Linux variants are provided for popular architectures. Debian variants are recommended.
2024-02-27 17:21:48 +01:00
Variants for PHP 8.2 and PHP 8.3 are provided. [Browse tags ](https://hub.docker.com/r/dunglas/frankenphp/tags ).
2022-10-21 16:23:23 +03:00
2022-11-03 09:04:29 +01:00
## How to Use The Images
Create a `Dockerfile` in your project:
2023-09-20 14:15:41 +02:00
``` dockerfile
2022-11-03 09:04:29 +01:00
FROM dunglas/frankenphp
COPY . /app/public
2022-10-21 16:23:23 +03:00
```
2024-02-27 17:21:48 +01:00
Then, run these commands to build and run the Docker image:
2022-10-21 16:23:23 +03:00
2023-09-20 14:15:41 +02:00
``` console
2023-12-01 17:26:21 +01:00
docker build -t my-php-app .
docker run -it --rm --name my-running-app my-php-app
2022-10-21 16:23:23 +03:00
```
2022-11-03 09:04:29 +01:00
## How to Install More PHP Extensions
The [`docker-php-extension-installer` ](https://github.com/mlocati/docker-php-extension-installer ) script is provided in the base image.
2023-11-07 05:13:15 +08:00
Adding additional PHP extensions is straightforward:
2022-10-21 16:23:23 +03:00
2022-11-03 09:04:29 +01:00
``` dockerfile
FROM dunglas/frankenphp
# add additional extensions here:
RUN install-php-extensions \
2024-01-29 14:40:56 +01:00
pdo_mysql \
gd \
intl \
zip \
opcache
2022-10-21 16:23:23 +03:00
```
2022-11-03 09:04:29 +01:00
2023-11-01 00:06:52 +01:00
## How to Install More Caddy Modules
FrankenPHP is built on top of Caddy, and all [Caddy modules ](https://caddyserver.com/docs/modules/ ) can be used with FrankenPHP.
The easiest way to install custom Caddy modules is to use [xcaddy ](https://github.com/caddyserver/xcaddy ):
``` dockerfile
FROM dunglas/frankenphp:latest-builder AS builder
# Copy xcaddy in the builder image
COPY --from= caddy:builder /usr/bin/xcaddy /usr/bin/xcaddy
# CGO must be enabled to build FrankenPHP
2023-12-14 22:45:09 +01:00
ENV CGO_ENABLED = 1 XCADDY_SETCAP = 1 XCADDY_GO_BUILD_FLAGS = "-ldflags '-w -s'"
2023-11-01 00:06:52 +01:00
RUN xcaddy build \
2024-01-29 14:40:56 +01:00
--output /usr/local/bin/frankenphp \
--with github.com/dunglas/frankenphp= ./ \
--with github.com/dunglas/frankenphp/caddy= ./caddy/ \
# Mercure and Vulcain are included in the official build, but feel free to remove them
2024-03-04 16:36:40 -05:00
--with github.com/dunglas/caddy-cbrotli \
2024-01-29 14:40:56 +01:00
--with github.com/dunglas/mercure/caddy \
--with github.com/dunglas/vulcain/caddy
# Add extra Caddy modules here
2023-11-01 00:06:52 +01:00
FROM dunglas/frankenphp AS runner
# Replace the official binary by the one contained your custom modules
COPY --from= builder /usr/local/bin/frankenphp /usr/local/bin/frankenphp
```
2024-02-27 17:21:48 +01:00
The `builder` image provided by FrankenPHP contains a compiled version of `libphp` .
[Builders images ](https://hub.docker.com/r/dunglas/frankenphp/tags?name=builder ) are provided for all versions of FrankenPHP and PHP, both for Debian and Alpine.
2023-11-01 00:06:52 +01:00
2023-12-14 22:45:09 +01:00
> [!TIP]
>
> If you're using Alpine Linux and Symfony,
> you may need to [increase the default stack size](compile.md#using-xcaddy).
2023-12-01 17:26:21 +01:00
## Enabling the Worker Mode by Default
2022-11-03 09:04:29 +01:00
Set the `FRANKENPHP_CONFIG` environment variable to start FrankenPHP with a worker script:
2023-09-20 14:15:41 +02:00
``` dockerfile
2022-11-03 09:04:29 +01:00
FROM dunglas/frankenphp
# ...
ENV FRANKENPHP_CONFIG = "worker ./public/index.php"
2022-10-21 16:23:23 +03:00
```
2023-12-01 17:26:21 +01:00
## Using a Volume in Development
2022-11-03 09:04:29 +01:00
To develop easily with FrankenPHP, mount the directory from your host containing the source code of the app as a volume in the Docker container:
2022-10-21 16:23:23 +03:00
2023-09-20 14:15:41 +02:00
``` console
2024-01-20 11:49:16 +01:00
docker run -v $PWD:/app/public -p 80:80 -p 443:443 -p 443:443/udp --tty my-php-app
2022-10-21 16:23:23 +03:00
```
2024-01-20 11:49:16 +01:00
> ![TIP]
>
> The `--tty` option allows to have nice human-readable logs instead of JSON logs.
2022-11-03 09:04:29 +01:00
With Docker Compose:
2022-10-21 16:23:23 +03:00
2022-11-03 09:04:29 +01:00
``` yaml
2023-11-30 08:07:39 +01:00
# compose.yaml
2022-11-03 09:04:29 +01:00
services :
php :
image : dunglas/frankenphp
# uncomment the following line if you want to use a custom Dockerfile
#build: .
2022-11-22 17:41:13 +01:00
# uncomment the following line if you want to run this in a production environment
# restart: always
2022-11-03 09:04:29 +01:00
ports :
2024-01-20 11:49:16 +01:00
- "80:80" # HTTP
- "443:443" # HTTPS
- "443:443/udp" # HTTP/3
2022-11-03 09:04:29 +01:00
volumes :
- ./:/app/public
2023-10-30 22:16:09 +01:00
- caddy_data:/data
- caddy_config:/config
# comment the following line in production, it allows to have nice human-readable logs in dev
tty : true
# Volumes needed for Caddy certificates and configuration
volumes :
caddy_data :
caddy_config :
2022-11-03 09:04:29 +01:00
```
2024-01-29 14:40:56 +01:00
## Running as a Non-Root User
2024-03-04 16:36:40 -05:00
FrankenPHP can run as non-root user in Docker.
2024-01-29 14:40:56 +01:00
Here is a sample `Dockerfile` doing this:
``` dockerfile
FROM dunglas/frankenphp
ARG USER = www-data
2024-02-11 16:03:08 +05:30
RUN \
# Use "adduser -D ${USER}" for alpine based distros
useradd -D ${ USER } ; \
# Add additional capability to bind to port 80 and 443
setcap CAP_NET_BIND_SERVICE = +eip /usr/local/bin/frankenphp; \
# Give write access to /data/caddy and /config/caddy
chown -R ${ USER } :${ USER } /data/caddy && chown -R ${ USER } :${ USER } /config/caddy;
USER ${USER }
2024-01-29 14:40:56 +01:00
```
2024-01-30 18:32:47 +01:00
## Updates
The Docker images are built:
* when a new release is tagged
2024-03-04 16:36:40 -05:00
* daily at 4 am UTC, if new versions of the official PHP images are available
2024-01-30 18:32:47 +01:00
## Development Versions
Development versions are available in the [`dunglas/frankenphp-dev` ](https://hub.docker.com/repository/docker/dunglas/frankenphp-dev ) Docker repository.
A new build is triggered every time a commit is pushed to the main branch of the GitHub repository.
The `latest*` tags point to the head of the `main` branch.
Tags of the form `sha-<git-commit-hash>` are also available.
