exp:frankenphp

Available since Exponential 6.0.15 (in development, not in a release yet).

Summary

Control the FrankenPHP engine of the Exponential web server

Usage

./console exp:frankenphp [options]
php bin/php/frankenphp.php [options]

Help

The output of ./console help exp:frankenphp (the script run with --help), without the standard options:

Usage: bin/php/frankenphp.php [OPTION]... [COMMAND]
Exponential web server, FrankenPHP engine - production

The same controller as exp:velocity and exp:webserver, pinned to the
frankenphp engine (Caddy with PHP built in). Every verb behaves exactly
as exp:velocity <verb> --engine=frankenphp; this command just fixes the
engine so you do not have to name it.

Commands:
  status      what the FrankenPHP engine is doing (the default)
  start       start it
  stop        ask it to stop, and wait
  restart     stop, then start
  graceful    re-exec without dropping the listening socket
  kill        stop without asking, for a wedged worker
  command     print the command line it would run, and exit
  config      read and write the settings it runs on
  cache       cache clear: re-render every cached page on its next request
  ctl         FrankenPHP's own control: ctl caddyfile | validate | adapt |
              version | list-modules
  install     download the pinned FrankenPHP release and verify its SHA-256
              (--force, --from=<file>, --check, --trust-github-digest)

FrankenPHP address and ports come from [FrankenPHPSettings] in velocity.ini
(Port for plain HTTP, HTTPSPort for TLS), so it runs beside the other
engines without clashing. HTTPS is on by default with a self-signed
certificate unless [HTTPSSettings] names one; --https / --no-https force it
for a single start.

This command targets the frankenphp engine. --engine=<other> is honoured if
you pass it (it then behaves as exp:velocity for that engine), and --all
reaches every engine; with neither, frankenphp is used.

Through the console:
  ./bin/php/console exp:frankenphp status --allow-root-user
  ./bin/php/console exp:frankenphp install --allow-root-user
  ./bin/php/console exp:fp status --allow-root-user   (exp:fp is shorthand)

Settings come from velocity.ini; override per installation in
settings/override/velocity.ini.append.php.


Options:
  --json                 Report as JSON, for a caller that is not a person
  --engine=VALUE         override the frankenphp default for this command only (php, qbix, or several)
  --all                  start, stop, restart, graceful, kill or status every engine, one after the other
  --force                install: download again even if the binary is already there
  --check                install: re-hash the installed binary against its SHA-256
  --trust-github-digest  install: accept the digest GitHub publishes when no Sha256 is pinned
  --from=VALUE           install: take the binary from this file instead of downloading it
  --keep-global=VALUE
  --https
  --no-https
  --apply                the commands that write (config set|unset, cache clear, install ...): make the change; without it they are a dry run, as with exp:velocity
  --dry-run              the default of the commands that write; passed on to exp:velocity

Options

Arguments

[command]

Standard options

Every script also takes the standard options of the script framework: --help, --quiet, --siteaccess, --debug, --colors, --no-colors, --logfiles, --no-logfiles, --verbose and --allow-root-user.

Source

bin/php/frankenphp.php, kernel/private/classes/commands/frankenphp.php

See also

Generated example: exp:frankenphp

Added to the reference for Exponential 6.0.15.