Skip to content
Hyperion

Edit a node's own settings

Some settings are acted on by each node from its own /etc/hyperion/agent.toml. The node settings page lets an Owner read and, where allowed, change those values on any node without SSH. For a worker that follows the master, the page is read-only. See Keep node settings in sync.

Before you start

Section titled “Before you start”
  • Sign in as an Owner. The page needs the Owner role and the Edit global settings capability.
  • The node must be reachable. Check it first with Check the health of your nodes.

Steps

Section titled “Steps”
  1. Open Nodes in the sidebar and click the node’s row. The master is the row marked this server.
  2. In Settings, click Edit <label> settings. You can also use the Settings link in the row’s facts strip. The page is titled <label> settings.
  3. For a worker, read the box at the top. It says “Settings from the master:” followed by in sync, not synced (old agent), sync failed or a note that it has not been checked yet.
    • If the cards below are read-only, the node follows the master. Change the value on Settings instead.
    • If they are editable, the node does not take the master’s settings, for example because its agent is old. Edit them here.
  4. Change a card and use its own button. Each card saves on its own.
  5. After a save the page shows “<card> saved on this node — its agent is restarting (~5s)”. Wait a few seconds before you test the result.

The cards

Section titled “The cards”
Group Card Writes to
Updates Automatic updates: Update <label> automatically. When on, the node checks hourly for a new Hyperion release and installs it in safe mode. System packages are never touched. [update]
Brute-force scanner Scan for login floods and ban offenders: the Window (seconds), the failure thresholds for Website login, SSH, FTP, Mail and WAF refusals, First ban (seconds), Repeat offender (seconds) and Counts as a repeat for (seconds). [fail2ban]
Backups What is kept (backup archives, snapshots or both), FTP / SFTP target with a Test connection button, Local copies, Archive retention and Snapshot retention. [protection], [backup_remote], [backup], [backup_retention], [snapshots]
Certificates & mail Let’s Encrypt contact: the address that receives this node’s expiry warnings. The outgoing mail relay has its own page, Settings, Mail, already switched to this node. [acme]

Raw configuration at the bottom shows the node’s agent.toml exactly as it is on disk, read-only. Passwords and keys are masked on the node itself and never sent to the master.

The page writes only these sections. [cluster], [notifications] and [email] are not editable per node, and a request to write another section is refused.

Test an off-site target from the node

Section titled “Test an off-site target from the node”

The FTP / SFTP target card has Test connection. It runs on the node against the target as saved, connects, logs in and lists the directory. After you save the target, give the agent a few seconds to restart before you test.

Check that it worked

Section titled “Check that it worked”
  • The page reloads at the card you changed with the “saved on this node” message.
  • Reload the page after a few seconds. The card shows the new value, and Raw configuration shows the changed section.
  • For the master’s own row, a save also triggers a settings sync, so workers that follow the master get the value within minutes.

If it fails

Section titled “If it fails”
  • “<label> is set for every node on Settings, and this node follows the master — change it there”: the node is managed by the sync. Change the value under Settings.
  • “<label> did not answer, so its settings can’t be shown.”: nothing is pre-filled from defaults, because saving defaults would overwrite real values. Use Test connection on the Nodes page.
  • “this node runs an older agent that cannot send its configuration — update it from the Nodes page”: Raw configuration is unavailable until the node is updated.
  • “<card> written to this node’s agent.toml. It runs an older agent that cannot restart itself on request, so the value takes effect when that agent next restarts — updating the node does that”: update the node.
  • “that section cannot be edited per node”: the request named a section this page cannot write. Reload the page and use the card’s own button.
  • “Brute-force scanner — thresholds unknown”: the node’s agent.toml did not parse, so no form is shown that would guess the values.
  • Redirected to the dashboard: you are not an Owner.
Section titled “Related”