Repository navigation
Unattended CLI install
Prepare settings in a file instead of walking through the wizard. Installation is still attended: keep an interactive root terminal, console recovery access and a second independent SSH connection.
Follow host preparation and the forwarding table. Use a reviewed checkout or verified unpacked installer and retain that directory. Existing installations must use their original retained installer.
| Office choice | Example |
|---|---|
| Native ONLYOFFICE | examples/config.json |
| Euro-Office | examples/eurooffice.json |
| Collabora CODE | examples/collabora.json |
| Nextcloud only | examples/nextcloud-only.json |
| External HTTPS proxy | examples/external-proxy.json |
For example, as root in the installer directory:
umask 077
test ! -e /root/nextcloud-install.json || exit 1
cp examples/config.json /root/nextcloud-install.json
chown root:wheel /root/nextcloud-install.json
chmod 600 /root/nextcloud-install.json
vi /root/nextcloud-install.jsonReplace all example hostnames, addresses and paths. Review apps, pool, interface, management CIDR, private networks/bridges, HTTPS, Talk ports and resource budgets. Client Push is included; selecting Talk adds a separate native HPB/TURN jail. Choose Nextcloud Mail or SnappyMail, not both. Office backends cannot be switched or shared across instances.
Add "external_storage": true to enable External files for SFTP or HTTP/HTTPS
storage. It is off by default. SMB/CIFS and FTP/FTPS are not installer options
in this release; leave external_storage_smb and external_storage_ftp out of new recipes.
The examples include "custom_egress": "v1" so you can add custom firewall rules
for each instance. See external storage and custom firewall rules.
Use public_hostname, not a saved WAN IP. ingress_address is the host's assigned
static IPv4; it may be private behind a router. For Talk, set talk_media_hostname,
normally the web hostname; use a different name if media reaches a different endpoint
from the HTTPS proxy. It is resolved once for Janus/coturn; TURN uses the hostname.
Future WAN/DNS and forwarding changes remain yours to manage.
External HTTPS requires proxy_callback_address, an explicit private/VPN frontend
IPv4 reachable from managed services. It need not appear in public DNS. Separately
set narrow proxy_networks to the trusted source CIDRs seen by the HTTP backend.
Keep the recipe root-owned and 0600, without passwords, JWTs or private keys.
Certificate/key fields reference protected files using absolute paths; jail SSH
uses a public key. Relative --config paths are relative to your current directory.
FreeBSD-ports latest is default; quarterly is an explicit alternative. Signed
pkg install may update pkg and required installed dependencies. Default package
names are apache24, mariadb123-server/client, php85 and matching modules.
Apps use occ app:install. VM offices use official Alpine latest-stable and their
container's :latest tag; Verify/Resume do not update completed workloads.
To disable default project branding, set "nextcloud_branding": false.
Fresh examples include "nextcloud_defaults": "v1". Set
"default_phone_region": "ZA" for South Africa (not +27) and
"timezone": "Africa/Johannesburg", or choose your own values. The bundled
resources/countries.json and resources/timezones.json list the choices.
These settings are independent; defaults are an empty phone region and UTC.
The Nextcloud 35/PHP 8.5/MariaDB 12.3 defaults are editable. For example:
{"version_families": {"nextcloud": "36.0", "php": "8.6", "database": "11.4"}}36 or 36.0 selects the newest stable Nextcloud release within that family.
PHP 8.6 generates php86 and matching modules; MariaDB 11.4 generates
mariadb114-server/client. These examples do not assert availability. For an exact
Nextcloud release, set top-level "nextcloud_exact": "36.0.1" and omit nextcloud
from version_families. Remove stale nextcloud_min values when selecting an older release.
Untested choices show a warning before APPLY, including with --yes, but can
still be attempted. Installation may fail if the software is unavailable or
incompatible; the installer does not substitute other versions.
The resources/tested-versions.json file records individual versions and optional
tested combinations separately. Individual records do not mean their combination
was tested. See
software versions for the format and how to edit it for new
installations. Keep existing instance settings and their original installers unchanged.
sh install.sh plan /root/nextcloud-install.jsonPlanning needs existing Python 3.11+ on Linux or FreeBSD. It does not inspect the destination host; review the live host checks and software summary during installation.
For interactive credentials and APPLY:
sh install.sh install --config /root/nextcloud-install.jsonFor native ONLYOFFICE with ACME, after reading the Microsoft webfonts licence and Let's Encrypt terms:
sh install.sh install --config /root/nextcloud-install.json --yes --accept-licenses --accept-acme-termsOmit --accept-licenses for other office choices; omit --accept-acme-terms with
supplied certificates or an external proxy. ONLYOFFICE needs webfonts consent with
either font profile; the recipe can record "accept_microsoft_fonts": true instead.
--yes approves missing pkg/Python prerequisites and APPLY, generates credentials
and skips the optional new-user prompt. It does not accept licences/ACME terms,
prepare an empty parent PF or answer KEEP. If you enable doas, answer its separate
approval prompt. Consent flags require install --config.
For text prompts, put --plain before install.
Open a new independent host SSH connection, check management access and enter
exact KEEP before the deadline. Repeat for each request. An existing connection
is not enough; missing confirmation causes network rollback.

Do not pipe answers, automate KEEP or schedule installation from cron.
Follow After installation. The installer
creates /var/db/cloud-installer/instances/INSTANCE/secrets.json automatically;
read credentials there privately.
If setup stops, read the recovery message before running
sh install.sh resume INSTANCE from the original installer. Keep saved settings
and referenced files unchanged; Resume may require APPLY and another timed KEEP.
Do not edit saved state to force a retry. Removal is also attended
and has no --yes option.