Every SQUIRE_* setting Squire reads, grouped by the script that reads it, with the file each group lives in and its default. All settings are optional. Next, see Commands for the CLI flags and Files for what Squire writes.
All optional. On Citadel, add ./.env.squire as a configuration file (the configuration-files step after the wizard; the wizard has no environment field) and keep it out of git. release.sh reads the release options from it, and a variable already in the environment wins. Locally, the same file holds the parity settings.
Group
Reader
File
Release script
scripts/release.sh
./.env.squire (on Citadel, added as a configuration file and kept out of git)
Front controller
raw public/index.php, static public/index.php
the app's environment
Health check
health.php
the app's environment
Local parity
the parity compose file
.env.squire (see .env.squire.example; it holds placeholders only)
auto, laravel or raw. Laravel is detected from artisan.
SQUIRE_ALLOW_ROOT
0
1 allows running as root.
SQUIRE_REQUIRE_ENV
auto
1 requires a .env file; auto means Laravel does.
SQUIRE_WRITABLE_DIRS
Laravel: storage, bootstrap/cache
Directories to create.
SQUIRE_COMPOSER_AUDIT
report
report, fail or skip.
SQUIRE_NPM
auto
auto or skip (for committed built assets).
SQUIRE_NPM_IGNORE_SCRIPTS
1
Install with --ignore-scripts (Yarn 2 and later: --mode=skip-build).
SQUIRE_NPM_REBUILD
empty
Packages, separated by spaces, whose install scripts run after the install (npm rebuild --ignore-scripts=false, pnpm rebuild, or yarn rebuild for Yarn 2 and later; Yarn 1 apps get npm rebuild; pnpm 10 also needs them in pnpm.onlyBuiltDependencies). The escape hatch for a package that needs its own scripts, such as a native addon.
SQUIRE_NPM_BUILD_SCRIPT
build
The package.json script to run.
SQUIRE_CACHE_DIR
.cache/squire
Where Composer and npm keep their download caches between releases, inside the app folder so a Citadel Update keeps them; off leaves their defaults.
SQUIRE_MIGRATE
1
Laravel: migrate --force.
SQUIRE_ARTISAN_OPTIMIZE
1
Laravel: optimize.
SQUIRE_ARTISAN_RESTART
1
Laravel: tell queue workers and schedule:work to restart on the new code (reload, or queue:restart and schedule:interrupt). Report only.
SQUIRE_PROCTOR
auto
auto, skip or enforce. The release asks proctor gate for a go or no-go (proctor check on a PROCTOR without the gate). By default a no-go is a report and never stops the release; enforce makes a no-go stop it, before the frontend build and the migrations.
SQUIRE_PROCTOR_BIN
vendor/bin/proctor, then PATH, then the fetch below
Where PROCTOR is. It is a dev dependency, so --no-dev removes it; set this to use a copy of your own (PROCTOR's tagged phar works, marked executable).
SQUIRE_PROCTOR_FETCH
1
When no PROCTOR is found, install the version composer.lock pins as a dev package into .cache/squire/proctor/<version> (composer create-project --no-dev, once per version) and run that. 0 turns it off. A failed fetch is a warning, or a stop under enforce. Needs SQUIRE_CACHE_DIR on.
SQUIRE_PROCTOR_POLICY
vendor/waynestate/creed/policy/policy.json, when installed
Path to the policy file. When unset, the script falls back to the policy the CREED package ships (the deploy wizard has no environment field); when CREED is not installed, PROCTOR runs on its own default policy with a notice. An explicit value always wins.
SQUIRE_PROCTOR_RECORD_DIR
storage/squire
Where the gate keeps its verdicts, relative to the app root: proctor-gate.json (the last verdict) and proctor-gate-baseline.json (the verdict of the last release that went on, the next run's baseline). The folder gets a .gitignore of *, so it never reaches git.
SQUIRE_PHP_RUNTIME
auto
The PHP version the gate grades for PROCTOR's unpatched check, passed as --php-runtime: auto reads the php that runs release.sh (it is the one serving the app; a suffix such as -dev is cut), skip grades no runtime, and an X.Y.Z value is graded as given. A value that is not X.Y.Z is a note and grades nothing. Only proctor gate gets it; the older proctor check fallback does not.
SQUIRE_SMOKE
1
Request the health URL at the end and fail unless it answers 200.
SQUIRE_SMOKE_URL
http://127.0.0.1:80/up (Laravel), /up.php (raw and static)
Full URL.
SQUIRE_SMOKE_RETRIES
5
Attempts.
SQUIRE_SMOKE_DELAY
2
Seconds between attempts.
SQUIRE_SECRETS_DIR
/run/secrets
A folder of secret files, read before the first step: each regular file named like a variable (DB_PASSWORD) becomes that variable, unless the environment already sets it. Only names are printed. The fallback entrypoint reads the same folder for Apache. See Image hardening.
PHP reads these from the container's environment when it starts (PHP 8.3 and later). The parity compose file passes SQUIRE_OPCACHE_VALIDATE and SQUIRE_PHP_DISABLE_FUNCTIONS from .env.squire; on Citadel the platform's own php.ini decides. See Image hardening.
Variable
Default
Meaning
SQUIRE_OPCACHE_VALIDATE
1
How code arrives. 1: pulled into the running container (Citadel, a bind mount, or unknown), so opcache checks files every 2 seconds. 0: baked into an image that never changes, so it never checks. Also a build argument of .squire/Dockerfile (default 1); the run-time value wins. Never empty: that turns the checks off.
The web's disable_functions list (.squire/php-web.ini; the CLI disables nothing). It replaces the list; none disables nothing. Leave it unset for the default: an empty value disables nothing too.
Local parity: the uid that owns the mounted source.
SQUIRE_SOURCE_GID
not stated
Local parity: the gid that owns the mounted source.
SQUIRE_DB_NAME
not stated
Local parity: the database name.
SQUIRE_DB_USER
not stated
Local parity: the database user.
SQUIRE_DB_PASSWORD
not stated
Local parity: the database password.
SQUIRE_DB_ROOT_PASSWORD
not stated
Local parity: the database root password.
SQUIRE_DB_PORT
not stated
Local parity: the database port.
SQUIRE_DB_MEMORY
not stated
Local parity: the database memory limit.
SQUIRE_PORTABLE_HTTP_PORT
8081
The portable profile: where the web container is published on loopback.
SQUIRE_PORTABLE_USER
10001:0
The portable profile: the UID and group the containers run as (try 1000123:0).
SQUIRE_PORTABLE_ENV_FILE
.env
The portable profile: the app's env file, read at run time and never baked in.
SQUIRE_PORTABLE_CONTEXT
.
The portable profile: the build context, relative to the compose file (.. for WELD).
SQUIRE_KIT_DIR
.
The portable profile: the kit's folder inside that context (deploy for WELD).
The Vue layer's compose file also reads SQUIRE_NODE_IMAGE (default node:22.23.4-bookworm-slim, pinned by digest), SQUIRE_NODE_ENV (default production) and SQUIRE_NODE_MEMORY (default 512m). The compose file refuses to start without the two passwords. See .env.squire.example; it holds placeholders only.