Elyra
 Elyra The coding agent e The native code editor Elyra Grove Native local development environment Askr The real server for Laravel & PHP Elyra Conductor Local project conductor Elyra SQL Anywhere Replication-ready SQL engine
Start here
Overview
Ubuntu setup
Building from source
Guides
Worker mode
CoW template
Shared cache
Broadcasting
Deployment
Reference
CLI reference
Configuration
Admin dashboard
Architecture
Release notes
Changelog
Elyra
Elyra
Askr
Configuration

Configuration

Askr can be configured with CLI flags (see CLI) or a typed askr.toml file. The config file is the declarative source of truth — the thing tooling and the admin GUI edit — and is recommended for production.

askr config-check askr.toml     # validate + print resolved settings
askr serve --config askr.toml   # run (the file is authoritative)

When --config is given, the file provides everything; other serve flags are ignored.

askr.toml reference

A complete, commented example lives at examples/askr.toml. Unknown keys are rejected, so typos fail fast in config-check.

[server]

Key Type Default Meaning
listen string 127.0.0.1:8000 Address to bind.
root path public Document root (the app's public/).
front string index.php Front controller, relative to root.
workers string auto Number of worker processes, or auto (= CPU cores).
max_requests int 0 Recycle each worker after N requests (0 = never).
max_body_size string 16M Reject larger bodies with 413. K/M/G or plain bytes.
https bool false Force HTTPS in $_SERVER (e.g. behind a TLS terminator). Implied by TLS.

[worker]

Omit this whole section to run in per-request mode. Present it to enable worker mode (boot once, serve many — see Worker mode).

Key Type Meaning
script path Worker script that boots the app and loops.
app_base path Application base path, exported as $ASKR_APP_BASE for the worker script (inherited across fork).
ini string Extra php.ini lines (newline-separated), e.g. to load opcache.
paranoid bool Dev only: detect state bleed between requests (expensive). See Worker mode.

[tls]

Key Type Meaning
cert path TLS certificate chain (PEM). Use with key.
key path TLS private key (PEM).
self_signed bool Generate a v3 self-signed cert on startup (dev). Mutually exclusive with cert/key.

Enabling TLS negotiates HTTP/2 or HTTP/1.1 via ALPN and sets HTTPS=on in $_SERVER (so Laravel emits secure cookies). Certs must be X.509 v3.

[admin]

Key Type Meaning
listen string Admin dashboard/API address (e.g. 127.0.0.1:9000). Omit to disable. See Admin.

[queue]

Run queue workers in the same binary, supervised alongside the web workers.

Key Type Meaning
workers int Number of queue-worker processes (0 = off).
script path Queue runner script (e.g. examples/askr-queue.php).

[scheduler]

Run the scheduler (built-in cron) in the same binary.

Key Type Meaning
script path Scheduler runner script (e.g. examples/askr-scheduler.php). Omit to disable.

[cache]

Enable the shared-memory cache (askr_cache_*, and the Laravel driver). See Cache.

Key Type Meaning
slots int Number of cache slots (0 = disabled). Each slot is ~4.3 KB.

[broadcast]

Enable askr_broadcast() and the SSE endpoint. See Broadcasting.

Key Type Meaning
enabled bool Turn on the broadcast ring + GET /askr/events.

[reload]

Key Type Meaning
canary bool Canary reload: roll one worker and health-check it before rolling the rest.

Example

[server]
listen = "0.0.0.0:8000"
root = "/var/www/app/public"
workers = "auto"
max_requests = 1000
max_body_size = "16M"

[worker]
script = "/opt/askr/examples/laravel-worker.php"
app_base = "/var/www/app"
ini = "zend_extension=/opt/askr/vendor/php-build/install/lib/php/extensions/no-debug-non-zts-20240924/opcache.so\nopcache.enable=1\nopcache.validate_timestamps=0"

[tls]
cert = "/etc/askr/cert.pem"
key = "/etc/askr/key.pem"

[admin]
listen = "127.0.0.1:9000"

Environment variables

Variable Meaning
ASKR_PHP_INI Extra php.ini lines, appended to the engine defaults. Overridden by --ini / [worker] ini. Commonly used to load opcache.
ASKR_APP_BASE Application base path for the worker script (set automatically from [worker] app_base, or export it yourself in flag mode).
ASKR_PHP_CONFIG Path to a php-config for a specific embed-enabled, non-ZTS PHP install (used at build time).
RUST_LOG Log filter, e.g. askr=debug. Default askr=info.

opcache

opcache is a zend_extension and must be loaded via the INI:

[worker]
ini = "zend_extension=/…/opcache.so\nopcache.enable=1\nopcache.enable_cli=1\nopcache.validate_timestamps=0"

validate_timestamps=0 maximises throughput (no stat() per file); pair it with a SIGHUP reload on deploy so fresh workers recompile the new code. The no-debug-non-zts-YYYYMMDD directory name encodes PHP's API version — match it to your build (askr doctor and the build script print the path).

Back to docs