The panel installer takes options for automated installs and special cases. To pass options when you pipe the script into bash, put them after bash -s --:
curl -fsSL https://vmstack.eu/install.sh | bash -s -- --domain panel.example.com --email [email protected] --yes
Or download the script and run bash install.sh [options]. bash install.sh --help prints the list below.
Options#
| Option | What it does |
|---|---|
--domain <name> |
The panel's domain, such as panel.example.com. A host name with at least two labels, not an address. Asked when not given. |
--email <address> |
The first administrator's e-mail. Asked when not given. |
--acme-email <address> |
The e-mail Let's Encrypt sends expiry notices to. Default: the administrator's. |
--channel stable|beta |
The release channel to install from and to update from later. Default stable. Use beta only on test panels. |
--release-url <url> |
Where releases are published (an https:// base address). Leave it at its default unless VMStack support gives you another. |
--licence-key <key> |
Activates this vmstack.eu licence key once the panel is up (also spelled --license-key). See below. |
--behind-cloudflare |
The domain is proxied by Cloudflare. See Cloudflare. |
--skip-dns-check |
Do not check that the domain's records point at this server. For servers behind NAT, where the public address is not on the server. |
--staging-cert |
Get a certificate from Let's Encrypt's staging service. Browsers do not trust it; for tests only, to stay clear of Let's Encrypt's rate limits. |
--no-firewall |
Leave the server's firewall alone. You then open 80 and 443 yourself. |
--no-swap |
Do not add the 2 GiB swap file (added only when the server has no swap and less than 8 GiB of memory). |
--yes, -y |
Ask nothing. --domain and --email are then required; the Let's Encrypt e-mail defaults to the administrator's. |
--repair |
Write every configuration file again on an installed panel (the same as vmstack-panel repair). |
--update [options] |
Update an installed panel with the updater in this script. Only for panels installed before the updater existed; others use vmstack-panel update. The options after it are the updater's (see Panel updates). |
-h, --help |
Print the options and exit. |
An unknown option stops the installer with "Unknown option: … (--help lists them)".
The answers and options are saved in /etc/vmstack/panel.conf, so an install that stopped continues with the same ones, and vmstack-panel repair and updates use them. --licence-key is the exception: the key is never saved.
Licence key#
--licence-key checks the key's shape first (VMS-STD-XXXX-XXXX-XXXX-XXXX; case, spaces and dashes do not matter) and stops at once on a key that cannot be one. The key is activated in the installer's last step, after the panel has passed its health check, exactly as System › Settings › Licence › Activate does. Only its first and last characters are printed.
Activation never makes the install fail. When vmstack.eu cannot be reached, or the key is in use on another panel, the summary says "not activated" with the reason, and the panel's Welcome screen asks for the key. See Activate a licence.
Examples#
An install without questions:
curl -fsSL https://vmstack.eu/install.sh | bash -s -- \
--domain panel.example.com --email [email protected] --yes
With a licence key and a separate Let's Encrypt address:
curl -fsSL https://vmstack.eu/install.sh | bash -s -- \
--domain panel.example.com --email [email protected] \
--acme-email [email protected] --licence-key VMS-STD-XXXX-XXXX-XXXX-XXXX --yes
A domain proxied by Cloudflare:
curl -fsSL https://vmstack.eu/install.sh | bash -s -- --behind-cloudflare
A test panel behind NAT, on the beta channel, with a staging certificate:
curl -fsSL https://vmstack.eu/install.sh | bash -s -- \
--skip-dns-check --staging-cert --channel beta
Behind NAT, the address nodes see the panel come from may not be the one the installer finds. The summary's Panel IP line shows what it found; it is VMSTACK_PANEL_IP in /opt/vmstack/shared/.env.
Values you can pin#
The installer computes the tuning from the server's CPUs and memory. A value set in /etc/vmstack/panel.conf wins over the computed one. Edit the file, then run vmstack-panel tune:
| Key | What |
|---|---|
FPM_MAX_CHILDREN, FPM_PM |
PHP-FPM workers and process manager (static or dynamic) |
PG_SHARED_BUFFERS_MB, PG_MAX_CONNECTIONS, PG_WORK_MEM_MB |
PostgreSQL memory and connections |
REDIS_MAXMEMORY_MB |
Redis memory |
NODES_WORKERS |
Queue workers for node calls (default 4; raise it with many nodes) |
WEBHOOKS_WORKERS |
Queue workers for webhooks (default 2) |
JIT |
off turns PHP's JIT off |
KEEP_RELEASES |
How many releases updates keep (default 3) |
NODES_WORKERS=6
FPM_MAX_CHILDREN=40