* docs: translated in Chinese * fix: readme md links and duplicate images * docs: lint and remove outdated parts --------- Co-authored-by: Pierre Clavequin <pierre.clavequin@valueapex.com> Co-authored-by: ginifizz <laury@les-tilleuls.coop> Co-authored-by: Kévin Dunglas <kevin@dunglas.fr>
4.6 KiB
构建自定义 Docker 镜像
FrankenPHP Docker 镜像基于官方PHP镜像。Alpine Linux 和 Debian 变体适用于流行的架构。提供了 PHP 8.2 和 PHP 8.3 的变体。浏览标签。
如何使用镜像
在项目中创建 Dockerfile:
FROM dunglas/frankenphp
COPY . /app/public
然后,运行以下命令以构建并运行 Docker 镜像:
docker build -t my-php-app .
docker run -it --rm --name my-running-app my-php-app
如何安装更多PHP扩展
docker-php-extension-installer脚本在基础镜像中提供。
添加额外的PHP扩展很简单:
FROM dunglas/frankenphp
# 在此处添加其他扩展:
RUN install-php-extensions \
pdo_mysql \
gd \
intl \
zip \
opcache
如何安装更多 Caddy 模块
FrankenPHP 建立在 Caddy 之上,所有 Caddy 模块 都可以与 FrankenPHP 一起使用。
安装自定义 Caddy 模块的最简单方法是使用 xcaddy:
FROM dunglas/frankenphp:latest-builder AS builder
# 在构建器镜像中复制 xcaddy
COPY --from=caddy:builder /usr/bin/xcaddy /usr/bin/xcaddy
# 必须启用 CGO 才能构建 FrankenPHP
ENV CGO_ENABLED=1 XCADDY_SETCAP=1 XCADDY_GO_BUILD_FLAGS="-ldflags '-w -s'"
RUN xcaddy build \
--output /usr/local/bin/frankenphp \
--with github.com/dunglas/frankenphp=./ \
--with github.com/dunglas/frankenphp/caddy=./caddy/ \
# Mercure 和 Vulcain 包含在官方版本中,但请随意删除它们
--with github.com/dunglas/mercure/caddy \
--with github.com/dunglas/vulcain/caddy
# 在此处添加额外的 Caddy 模块
FROM dunglas/frankenphp AS runner
# 将官方二进制文件替换为包含自定义模块的二进制文件
COPY --from=builder /usr/local/bin/frankenphp /usr/local/bin/frankenphp
FrankenPHP 提供的 builder 镜像包含 libphp 的编译版本。
构建器图像 适用于所有版本的 FrankenPHP 和 PHP,包括 Alpine 和 Debian。
[!提示]
如果您使用的是 Alpine Linux 和 Symfony, 您可能需要 增加默认堆栈大小。
默认启用 worker 模式
设置 FRANKENPHP_CONFIG 环境变量以使用 worker 脚本启动 FrankenPHP:
FROM dunglas/frankenphp
# ...
ENV FRANKENPHP_CONFIG="worker ./public/index.php"
在开发中使用 Volume
要使用 FrankenPHP 轻松开发,请从包含应用程序源代码的主机挂载目录作为 Docker 容器中的 volume:
docker run -v $PWD:/app/public -p 80:80 -p 443:443 -p 443:443/udp --tty my-php-app
[!提示]
--tty选项允许使用清晰可读的日志,而不是 JSON 日志。
使用 Docker Compose:
# compose.yaml
services:
php:
image: dunglas/frankenphp
# 如果要使用自定义 Dockerfile,请取消注释以下行
#build: .
# 如果要在生产环境中运行,请取消注释以下行
# restart: always
ports:
- "80:80" # HTTP
- "443:443" # HTTPS
- "443:443/udp" # HTTP/3
volumes:
- ./:/app/public
- caddy_data:/data
- caddy_config:/config
# 在生产环境中注释以下行,它允许在 dev 中使用清晰可读日志
tty: true
# Caddy 证书和配置所需的 volumes
volumes:
caddy_data:
caddy_config:
以非 root 用户身份运行
FrankenPHP 可以在 Docker 中以非 root 用户身份运行。
下面是一个示例 Dockerfile:
FROM dunglas/frankenphp
ARG USER=www-data
RUN \
# 在基于 alpine 的发行版使用 "adduser -D ${USER}"
useradd -D ${USER}; \
# 需要开放80和443端口的权限
setcap CAP_NET_BIND_SERVICE=+eip /usr/local/bin/frankenphp; \
# 需要 /data/caddy 和 /config/caddy 目录的写入权限
chown -R ${USER}:${USER} /data/caddy && chown -R ${USER}:${USER} /config/caddy;
USER ${USER}
更新
Docker 镜像会按照以下条件更新:
- 发布新的版本后
- 每天的 4am UTC 检查如果有新的PHP镜像可用
开发版本
可在此dockerdunglas/frankenphp-dev仓库路径获取开发版本。
每次在GitHub仓库的主分支有了新的commit都会触发一个新的build。
'latest*' tag 指向最新的main分支。
也支持 'sha-' 的tag格式。