add documentation about the php-server command

henderkes · henderkes · commit d072ab232178 · 2025-05-16T16:04:33.000+07:00
diff --git a/docs/cn/config.md b/docs/cn/config.md
@@ -138,7 +138,7 @@ route {
 
 ```caddyfile
 php_server [<matcher>] {
-	root <directory> # 设置站点的根目录。默认值：`root` 指令。
+	root <directory> # 设置站点的根目录。默认值：`root` 指令。如果未指定，默认将使用 current_working_dir/public 目录。
 	split_path <delim...> # 设置用于将 URI 拆分为两部分的子字符串。第一个匹配的子字符串将用于从路径中拆分“路径信息”。第一个部分以匹配的子字符串为后缀，并将假定为实际资源(CGI 脚本)名称。第二部分将设置为PATH_INFO，供脚本使用。默认值：`.php`
 	resolve_root_symlink false # 禁用将 `root` 目录在符号链接时将其解析为实际值（默认启用）。
 	env <key> <value> # 设置额外的环境变量，可以设置多个环境变量。
@@ -159,6 +159,43 @@ php_server [<matcher>] {
 可以使用 `PHP_INI_SCAN_DIR` 环境变量。
 设置后，PHP 将加载给定目录中存在 `.ini` 扩展名的所有文件。
 
+## php-server 命令
+
+`php-server` 命令是启动生产就绪 PHP 服务器的便捷方式。它特别适用于快速部署、演示、开发或运行[嵌入式应用](embed.md)。
+
+```console
+frankenphp php-server [--domain <example.com>] [--root <path>] [--listen <addr>] [--worker /path/to/worker.php<,nb-workers>] [--watch <paths...>] [--access-log] [--debug] [--no-compress] [--mercure]
+```
+
+### 选项
+
+- `--domain`, `-d`: 提供文件的域名。如果指定，服务器将使用 HTTPS 并自动获取 Let's Encrypt 证书。
+- `--root`, `-r`: 站点根目录的路径。如果未指定并使用嵌入式应用，默认将使用 embedded_app/public 目录。
+- `--listen`, `-l`: 绑定监听器的地址。默认为 `:80`，如果指定了域名则为 `:443`。
+- `--worker`, `-w`: 要运行的 worker 脚本。可以多次指定以运行多个 worker。
+- `--watch`: 监视文件更改的目录。可以多次指定以监视多个目录。
+- `--access-log`, `-a`: 启用访问日志。
+- `--debug`, `-v`: 启用详细调试日志。
+- `--mercure`, `-m`: 启用内置的 Mercure.rocks hub。
+- `--no-compress`: 禁用 Zstandard、Brotli 和 Gzip 压缩。
+
+### 示例
+
+使用当前目录作为文档根目录启动服务器：
+```console
+frankenphp php-server --root ./
+```
+
+启动启用 HTTPS 的服务器：
+```console
+frankenphp php-server --domain example.com
+```
+
+启动带有 worker 的服务器：
+```console
+frankenphp php-server --worker public/index.php
+```
+
 ## 启用调试模式
 
 使用 Docker 镜像时，将 `CADDY_GLOBAL_OPTIONS` 环境变量设置为 `debug` 以启用调试模式：
diff --git a/docs/cn/embed.md b/docs/cn/embed.md
@@ -39,6 +39,11 @@ composer install --ignore-platform-reqs --no-dev -a
 composer dump-env prod
 ```
 
+### 自定义配置
+
+要自定义[配置](config.md)，您可以在要嵌入的应用程序的主目录中放置 `Caddyfile` 和 `php.ini` 文件。
+如果嵌入了带有 Caddyfile 的应用程序，运行二进制文件时将自动使用该 Caddyfile 的配置。
+
 ## 创建 Linux 二进制文件
 
 创建 Linux 二进制文件的最简单方法是使用我们提供的基于 Docker 的构建器。
@@ -102,6 +107,12 @@ EMBED=/path/to/your/app \
 ./my-app php-server
 ```
 
+默认情况下，如果未指定 root 选项，它将使用 embedded_app/public 目录作为文档根目录。如果您想直接从嵌入式应用程序目录提供服务，请指定 root 选项：
+
+```console
+./my-app php-server --root ./
+```
+
 如果您的应用包含 [worker 脚本](worker.md)，请使用如下命令启动 worker：
 
 ```console
diff --git a/docs/config.md b/docs/config.md
@@ -149,7 +149,7 @@ The `php_server` and the `php` directives have the following options:
 
 ```caddyfile
 php_server [<matcher>] {
-	root <directory> # Sets the root folder to the site. Default: `root` directive.
+	root <directory> # Sets the root folder to the site. Default: `root` directive. If not specified, it will use the current_working_dir/public directory by default.
 	split_path <delim...> # Sets the substrings for splitting the URI into two parts. The first matching substring will be used to split the "path info" from the path. The first piece is suffixed with the matching substring and will be assumed as the actual resource (CGI script) name. The second piece will be set to PATH_INFO for the script to use. Default: `.php`
 	resolve_root_symlink false # Disables resolving the `root` directory to its actual value by evaluating a symbolic link, if one exists (enabled by default).
 	env <key> <value> # Sets an extra environment variable to the given value. Can be specified more than once for multiple environment variables.
@@ -265,6 +265,43 @@ You can also change the PHP configuration using the `php_ini` directive in the `
 }
 ```
 
+## The php-server Command
+
+The `php-server` command is a convenient way to start a production-ready PHP server. It's especially useful for quick deployments, demos, development, or to run an [embedded app](embed.md).
+
+```console
+frankenphp php-server [--domain <example.com>] [--root <path>] [--listen <addr>] [--worker /path/to/worker.php<,nb-workers>] [--watch <paths...>] [--access-log] [--debug] [--no-compress] [--mercure]
+```
+
+### Options
+
+- `--domain`, `-d`: Domain name at which to serve the files. If specified, the server will use HTTPS and automatically obtain a Let's Encrypt certificate.
+- `--root`, `-r`: The path to the root of the site. If not specified and using an embedded app, it will use the embedded_app/public directory by default.
+- `--listen`, `-l`: The address to which to bind the listener. Default is `:80` or `:443` if a domain is specified.
+- `--worker`, `-w`: Worker script to run. Can be specified multiple times for multiple workers.
+- `--watch`: Directory to watch for file changes. Can be specified multiple times for multiple directories.
+- `--access-log`, `-a`: Enable the access log.
+- `--debug`, `-v`: Enable verbose debug logs.
+- `--mercure`, `-m`: Enable the built-in Mercure.rocks hub.
+- `--no-compress`: Disable Zstandard, Brotli and Gzip compression.
+
+### Examples
+
+Start a server with the current directory as the document root:
+```console
+frankenphp php-server --root ./
+```
+
+Start a server with HTTPS enabled:
+```console
+frankenphp php-server --domain example.com
+```
+
+Start a server with a worker:
+```console
+frankenphp php-server --worker public/index.php
+```
+
 ## Enable the Debug Mode
 
 When using the Docker image, set the `CADDY_GLOBAL_OPTIONS` environment variable to `debug` to enable the debug mode:
diff --git a/docs/embed.md b/docs/embed.md
@@ -47,6 +47,8 @@ composer dump-env prod
 To customize [the configuration](config.md), you can put a `Caddyfile` as well as a `php.ini` file
 in the main directory of the app to be embedded (`$TMPDIR/my-prepared-app` in the previous example).
 
+If an app with a Caddyfile in the directory is embedded, it will use that Caddyfile's configuration automatically when running the binary.
+
 ## Creating a Linux Binary
 
 The easiest way to create a Linux binary is to use the Docker-based builder we provide.
@@ -106,6 +108,12 @@ To start the web app run:
 ./my-app php-server
 ```
 
+By default, if no root option is specified, it will use the embedded_app/public directory as the document root. If you want to serve directly from the embedded app directory, specify the root option:
+
+```console
+./my-app php-server --root ./
+```
+
 If your app contains a [worker script](worker.md), start the worker with something like:
 
 ```console
diff --git a/docs/fr/config.md b/docs/fr/config.md
@@ -148,7 +148,7 @@ Les directives `php_server` et `php` disposent des options suivantes :
 
 ```caddyfile
 php_server [<matcher>] {
-    root <directory> # Définit le dossier racine du le site. Par défaut : valeur de la directive `root` parente.
+    root <directory> # Définit le dossier racine du le site. Par défaut : valeur de la directive `root` parente. Si non spécifié, il utilisera le répertoire current_working_dir/public par défaut.
     split_path <delim...> # Définit les sous-chaînes pour diviser l'URI en deux parties. La première sous-chaîne correspondante sera utilisée pour séparer le "path info" du chemin. La première partie est suffixée avec la sous-chaîne correspondante et sera considérée comme le nom réel de la ressource (script CGI). La seconde partie sera définie comme PATH_INFO pour utilisation par le script. Par défaut : `.php`
     resolve_root_symlink false # Désactive la résolution du répertoire `root` vers sa valeur réelle en évaluant un lien symbolique, s'il existe (activé par défaut).
     env <key> <value> # Définit une variable d'environnement supplémentaire avec la valeur donnée. Peut être spécifié plusieurs fois pour plusieurs variables d'environnement.
@@ -264,6 +264,43 @@ Vous pouvez également modifier la configuration de PHP en utilisant la directiv
 }
 ```
 
+## La commande php-server
+
+La commande `php-server` est un moyen pratique de démarrer un serveur PHP prêt pour la production. Elle est particulièrement utile pour les déploiements rapides, les démonstrations, le développement, ou pour exécuter une [application embarquée](embed.md).
+
+```console
+frankenphp php-server [--domain <example.com>] [--root <path>] [--listen <addr>] [--worker /path/to/worker.php<,nb-workers>] [--watch <paths...>] [--access-log] [--debug] [--no-compress] [--mercure]
+```
+
+### Options
+
+- `--domain`, `-d` : Nom de domaine sur lequel servir les fichiers. Si spécifié, le serveur utilisera HTTPS et obtiendra automatiquement un certificat Let's Encrypt.
+- `--root`, `-r` : Chemin vers la racine du site. Si non spécifié et en utilisant une application embarquée, il utilisera le répertoire embedded_app/public par défaut.
+- `--listen`, `-l` : L'adresse à laquelle lier l'écouteur. Par défaut, c'est `:80` ou `:443` si un domaine est spécifié.
+- `--worker`, `-w` : Script worker à exécuter. Peut être spécifié plusieurs fois pour plusieurs workers.
+- `--watch` : Répertoire à surveiller pour les changements de fichiers. Peut être spécifié plusieurs fois pour plusieurs répertoires.
+- `--access-log`, `-a` : Activer le journal d'accès.
+- `--debug`, `-v` : Activer les journaux de débogage détaillés.
+- `--mercure`, `-m` : Activer le hub Mercure.rocks intégré.
+- `--no-compress` : Désactiver la compression Zstandard, Brotli et Gzip.
+
+### Exemples
+
+Démarrer un serveur avec le répertoire courant comme racine de document :
+```console
+frankenphp php-server --root ./
+```
+
+Démarrer un serveur avec HTTPS activé :
+```console
+frankenphp php-server --domain example.com
+```
+
+Démarrer un serveur avec un worker :
+```console
+frankenphp php-server --worker public/index.php
+```
+
 ## Activer le mode debug
 
 Lors de l'utilisation de l'image Docker, définissez la variable d'environnement `CADDY_GLOBAL_OPTIONS` sur `debug` pour activer le mode debug :
diff --git a/docs/fr/embed.md b/docs/fr/embed.md
@@ -48,6 +48,7 @@ Pour personnaliser [la configuration](config.md),
 vous pouvez mettre un fichier `Caddyfile` ainsi qu'un fichier `php.ini`
 dans le répertoire principal de l'application à intégrer
 (`$TMPDIR/my-prepared-app` dans l'exemple précédent).
+Si une application avec un Caddyfile dans le répertoire est intégrée, elle utilisera automatiquement la configuration de ce Caddyfile lors de l'exécution du binaire.
 
 ## Créer un binaire Linux
 
@@ -108,6 +109,12 @@ Pour démarrer l'application web, exécutez :
 ./my-app php-server
 ```
 
+Par défaut, si aucune option root n'est spécifiée, il utilisera le répertoire embedded_app/public comme racine de document. Si vous souhaitez servir directement depuis le répertoire de l'application embarquée, spécifiez l'option root :
+
+```console
+./my-app php-server --root ./
+```
+
 Si votre application contient un [script worker](worker.md), démarrez le worker avec quelque chose comme :
 
 ```console
diff --git a/docs/ru/config.md b/docs/ru/config.md
@@ -141,7 +141,7 @@ route {
 
 ```caddyfile
 php_server [<matcher>] {
-	root <directory> # Указывает корневую директорию сайта. По умолчанию: директива `root`.
+	root <directory> # Указывает корневую директорию сайта. По умолчанию: директива `root`. Если не указано, по умолчанию будет использоваться директория current_working_dir/public.
 	split_path <delim...> # Устанавливает подстроки для разделения URI на две части. Первая часть будет использована как имя ресурса (CGI-скрипта), вторая часть — как PATH_INFO. По умолчанию: `.php`.
 	resolve_root_symlink false # Отключает разрешение символьных ссылок для `root` (включено по умолчанию).
 	env <key> <value> # Устанавливает дополнительные переменные окружения. Можно указать несколько раз для разных переменных.
@@ -234,6 +234,43 @@ CADDY_GLOBAL_OPTIONS="servers {
 Для загрузки [дополнительных конфигурационных файлов PHP](https://www.php.net/manual/en/configuration.file.php#configuration.file.scan) можно использовать переменную окружения `PHP_INI_SCAN_DIR`.
 Если она установлена, PHP загрузит все файлы с расширением `.ini`, находящиеся в указанных директориях.
 
+## Команда php-server
+
+Команда `php-server` — это удобный способ запустить готовый к продакшну PHP-сервер. Она особенно полезна для быстрого развертывания, демонстраций, разработки или запуска [встроенного приложения](embed.md).
+
+```console
+frankenphp php-server [--domain <example.com>] [--root <path>] [--listen <addr>] [--worker /path/to/worker.php<,nb-workers>] [--watch <paths...>] [--access-log] [--debug] [--no-compress] [--mercure]
+```
+
+### Опции
+
+- `--domain`, `-d`: Доменное имя, на котором будут обслуживаться файлы. Если указано, сервер будет использовать HTTPS и автоматически получит сертификат Let's Encrypt.
+- `--root`, `-r`: Путь к корневой директории сайта. Если не указано и используется встроенное приложение, по умолчанию будет использоваться директория embedded_app/public.
+- `--listen`, `-l`: Адрес, к которому будет привязан слушатель. По умолчанию `:80` или `:443`, если указан домен.
+- `--worker`, `-w`: Скрипт worker для запуска. Может быть указан несколько раз для нескольких workers.
+- `--watch`: Директория для отслеживания изменений файлов. Может быть указана несколько раз для нескольких директорий.
+- `--access-log`, `-a`: Включить журнал доступа.
+- `--debug`, `-v`: Включить подробные журналы отладки.
+- `--mercure`, `-m`: Включить встроенный хаб Mercure.rocks.
+- `--no-compress`: Отключить сжатие Zstandard, Brotli и Gzip.
+
+### Примеры
+
+Запуск сервера с текущей директорией в качестве корневой:
+```console
+frankenphp php-server --root ./
+```
+
+Запуск сервера с включенным HTTPS:
+```console
+frankenphp php-server --domain example.com
+```
+
+Запуск сервера с worker:
+```console
+frankenphp php-server --worker public/index.php
+```
+
 ## Включение режима отладки
 
 При использовании Docker-образа установите переменную окружения `CADDY_GLOBAL_OPTIONS` в `debug`, чтобы включить режим отладки:
diff --git a/docs/ru/embed.md b/docs/ru/embed.md
@@ -44,6 +44,7 @@ composer dump-env prod
 ### Настройка конфигурации
 
 Чтобы настроить [конфигурацию](config.md), вы можете разместить файлы `Caddyfile` и `php.ini` в основной директории приложения (`$TMPDIR/my-prepared-app` в примере выше).
+Если приложение с файлом Caddyfile в директории встроено, оно будет автоматически использовать конфигурацию из этого Caddyfile при запуске бинарного файла.
 
 ## Создание бинарного файла для Linux
 
@@ -104,6 +105,12 @@ EMBED=/path/to/your/app ./build-static.sh
 ./my-app php-server
 ```
 
+По умолчанию, если опция root не указана, будет использоваться директория embedded_app/public в качестве корневой. Если вы хотите обслуживать файлы непосредственно из директории встроенного приложения, укажите опцию root:
+
+```console
+./my-app php-server --root ./
+```
+
 Если ваше приложение содержит [worker-скрипт](worker.md), запустите его следующим образом:
 
 ```console
diff --git a/docs/tr/config.md b/docs/tr/config.md
diff --git a/docs/tr/embed.md b/docs/tr/embed.md
