Installer reference
On this page
install.sh installs Moorhold on a server, upgrades a server that runs another release, or checks
a server without installing. Each release has its own installer at
https://get.moorhold.dev/<version>/install.sh, and it installs that release only. This page
describes the installer of the latest release (2026.11.4). The install guides, such
as Install on your own server, walk through
using it.
Synopsis
Section titled "Synopsis"sudo bash install.sh --hostname <name> [--profile full|core] [--access-key-file <path>] [--acme production|staging] [--keep-access-key-file] [--sample-data | --no-sample-data] [--change-hostname]sudo bash install.sh --check --hostname <name> [--profile full|core]sudo bash install.sh --local [--access-key-file <path>] [--keep-access-key-file] [--no-sample-data]Options
Section titled "Options"| Option | What it does |
|---|---|
--hostname <name> |
The name the server is reached at, such as data.yourorg.example: lower-case letters, digits, hyphens and dots. Needed for a fresh install. An upgrade can leave it out, because the installed Stack has it. |
--profile full|core |
What to run. full runs every tool and needs a 12 GB server. core leaves out Apache Superset and DataHub and needs an 8 GB server. light is for --local only. On a terminal, a fresh install with no --profile asks. Without a terminal it's full. A server that's installed keeps its profile unless you give this. |
--access-key-file <path> |
A regular file holding your access key, of mode 0600. A symbolic link is refused. The file is deleted once the images are pulled, unless you give --keep-access-key-file. Without it, the installer uses the key the server keeps, or asks in a terminal without echo. |
--keep-access-key-file |
Don't delete the access key file. |
--acme production|staging |
Which Let's Encrypt service issues the certificate. Default production. staging is for testing. |
--sample-data |
Load Moorhold sample: AI Release Radar. |
--no-sample-data |
Don't load the sample, and don't ask. |
--change-hostname |
Move an installed Moorhold to the hostname given, without asking. On a terminal you're asked instead. |
--check |
Run the checks and stop. See Checking a server. |
--local |
Install for one person on this computer, as the Moorhold app for Mac does: no hostname, no certificate and no network check, and the light profile. It needs no access key unless you give one or the computer keeps one. Moorhold is reached at http://127.0.0.1:47300. It's refused with --hostname, --acme, --change-hostname or --check, and on a server that's already installed or upgrading. |
-h, --help |
Print the usage and stop. |
The installer refuses an access key on the command line or in the MOORHOLD_ACCESS_KEY
environment variable.
What it needs
Section titled "What it needs"- To run as root.
- The installer accepts Ubuntu 24.04, Ubuntu 26.04 or Debian 12. It refuses any other system. See Requirements for what's tested.
- An x86-64 processor for a server. On an ARM (aarch64) server, the installer stops once it has checked the release's signature, before it installs any of Moorhold, and says: "this server has an ARM (aarch64) processor: Moorhold servers need x86_64. ARM is for local mode on a Mac (--local)".
- Memory for the profile: 11 GiB for
full, 5.5 GiB forcore. A 12 GB server reports about 11.7 GiB. A--localinstall needs 3.5 GiB, which the Moorhold app for Mac's 4 GB virtual machine has.
What it does
Section titled "What it does"- Refuses an access key on the command line or in the environment.
- Checks that this server has enough memory for the profile (11 GiB for
full, 5.5 GiB forcore).--checkreports the memory with the later checks instead of stopping here. An upgrade skips this check. - Installs
curl,minisignandxzif they're missing, from the system's own signed archive.--checkdoesn't install them: if they're missing, it stops and tells you to install them first. - Downloads the release lock and checks its minisign signature against the release key built into
the installer. It stops if the signature doesn't verify, or if the lock is for another release. On
an ARM (aarch64) server without
--local, it stops here, before it installs any of Moorhold. - Writes the release key to
/etc/moorhold/release.pub, which later upgrades are checked with.--checkskips this write. - Looks up Node and the Moorhold bundle for this processor in the lock. It stops if either is missing.
- Downloads Node and the Moorhold bundle and checks each against the sha256 the lock pins.
- On a fresh install, runs the checks below. A blocking finding stops it here, before it asks for
the access key or pulls an image.
--checkruns those checks from the verified bundle and stops, without installing Docker or handing over. - Installs Docker Engine and Compose from the system's own archive, if they're missing.
- Hands over to
moorhold install, which writes the Stack for your hostname, generates every secret, pulls every image by digest with your access key, starts and applies the stack, and keeps the access key in/etc/moorhold/secrets/registry-access-key, readable by root only.
When it's done, it shows the address to open and where to read the one-time setup code:
sudo cat /etc/moorhold/secrets/MOORHOLD_SETUP_CODEThen open https://<hostname>/setup. Nothing the installer prints holds a secret.
Questions it asks
Section titled "Questions it asks"On a terminal, a fresh install asks what the options don't say:
Core needs an 8 GB machine, full needs a 12 GB machine. Which do you want? [core/full]Load the sample data, Moorhold sample: AI Release Radar? You can remove it later. [y/N]. Anything butyoryesleaves it out.Moorhold access key (from account.moorhold.dev; not shown):when there's no key file and the server keeps no key.
Without a terminal, it asks nothing: the profile is full unless given, the sample is left out
unless --sample-data, and an access key must come from a file or the server's kept copy.
Checking a server
Section titled "Checking a server"sudo bash install.sh --check --hostname <name> [--profile full|core]Runs the installer's checks and stops: the system, memory for the profile, disk space and
unallocated LVM space, sleep on a desktop install, ports 80 and 443, DNS and where the name points,
NAT loopback and carrier-grade NAT. It installs nothing, writes nothing outside a temporary
directory, and asks for no key. It uses full unless you give --profile, or the server is installed, when it uses the server's profile.
When curl, minisign or xz is missing, it says how to install it and stops with exit code 3,
because it won't run what it can't verify. On an installed server, sudo moorhold check runs the
same checks.
Running it again
Section titled "Running it again"| The server has | The installer |
|---|---|
| Nothing | Installs. |
This release, and you give --hostname |
Repairs the install, keeping its data, its secrets and the sample's state. With another hostname, it moves the install there. |
This release, and no --hostname |
Says there's nothing to update and exits 0. |
| Another release | Upgrades it. It unpacks this release beside the running one and hands over to this release's moorhold upgrade --staged, which switches /opt/moorhold/current only once the new release is up. --acme, --sample-data and --no-sample-data are refused. |
| An install that didn't finish | Asks you to run it again with --hostname to finish it. |
Exit codes
Section titled "Exit codes"| Code | Means |
|---|---|
| 0 | Installed, upgraded, or nothing to update. |
| 1 | It stopped: the message says why. |
| 2 | The options were wrong, or the access key came the wrong way. |
| 3 | --check needs curl, minisign or xz, and they're missing. |
Cloud-init
Section titled "Cloud-init"Each release publishes cloud-init files for Hetzner and IONOS:
https://get.moorhold.dev/<version>/cloud-init-hetzner.yaml and cloud-init-ionos.yaml. Each
writes your access key to /run/moorhold-install/access-key (mode 0600, root only), downloads
that release's install.sh, checks its sha256, and runs it:
write_files: - path: /run/moorhold-install/access-key owner: root:root permissions: "0600" content: | <your access key>runcmd: - - bash - -c - | set -eu curl -fsSL --proto '=https' --tlsv1.2 -o /run/moorhold-install/install.sh https://get.moorhold.dev/<version>/install.sh echo '<installer sha256> /run/moorhold-install/install.sh' | sha256sum -c - bash /run/moorhold-install/install.sh --hostname '<data.yourorg.example>' --profile full --access-key-file /run/moorhold-install/access-keyThe files on get.moorhold.dev have the release and the sha256 filled in. Put in your access key and hostname. The Hetzner and IONOS guides show where to paste it.