Skip to main content

Dashboard: Settings

The Settings page allows admins to configure the Routerly service, notification channels, and view system information. It is only accessible to users with the admin role.

Open Settings from the Settings item in the sidebar.


General Tab​

Service Configuration​

FieldDescription
PortThe port the service listens on (read-only — change via CLI or environment variable)
HostThe bind address (read-only)
Public URLThe externally accessible URL of this Routerly instance. Shown in project connection snippets
Default TimeoutPer-request timeout in milliseconds (applies to all projects unless overridden per-project)
Log Leveltrace / debug / info / warn / error
Dashboard EnabledToggle the web dashboard on or off

Changes are saved immediately and take effect without a restart (except Port and Host, which require a restart).


Notifications Tab​

Configure one or more notification channels for budget alerts.

Adding a Channel​

  1. Click + Add Channel
  2. Select the channel type: SMTP, SES, SendGrid, Azure, Google, Webhook
  3. Fill in the connection details for the selected type
  4. Click Save
  5. Click Send Test to verify the channel delivers a message correctly

See Concepts: Notifications for the configuration fields required by each provider.

Testing a Channel​

Click Send Test next to a channel. Routerly sends a test message immediately. Check for a success toast or an error with details.

Removing a Channel​

Click the Delete icon next to a channel.


About Tab​

Application​

System information about the running instance:

FieldDescription
VersionRouterly version string
ChannelActive update channel: latest, stable, develop, or a pinned version tag. Editable — see Update Channel below
UptimeHow long the service has been running since last start
Node.jsNode.js runtime version
PlatformOS and architecture
Config DirectoryPath to ~/.routerly/config/ (or $ROUTERLY_HOME/config/)

Update Channel​

The channel selector lets you choose which release stream Routerly follows when checking for updates:

ChannelDescription
latestMost recent release (may include pre-releases)
stableMost recent production-stable release
developDevelopment pre-release builds
Custom versionPin to a specific release tag (e.g. v0.2.0)

Changing the channel takes effect immediately — the running service is notified without a restart.

To enter a specific version tag, select Custom… in the dropdown. Type the tag (e.g. v0.2.0) and click Apply.

You can also change the channel from the CLI:

routerly update channel stable
routerly update channel v0.2.0

Software Update​

Shows the current update status for the active channel. The service checks for new releases automatically every 24 hours.

FieldDescription
Current versionThe version currently running
Available versionThe latest version on the active channel, or "Up to date" if already current
Last checkedTimestamp of the most recent check against the GitHub Releases API

Check for updates forces an immediate check against the GitHub Releases API and refreshes the displayed result.

Update to vX.Y.Z — visible only when a newer version is available on the current channel and the service is not running inside Docker. Clicking it triggers an in-app update:

  1. The service downloads and runs the installer for the new version in the background
  2. The service restarts automatically
  3. The dashboard reloads once the service is back online (polled every 3 seconds, up to 60 seconds)
Docker deployments

In-app update is disabled when Routerly is running inside a Docker container. Pull the new image and recreate the container instead:

docker pull inebrio/routerly:latest
docker compose up -d

Admin Update Banner​

When a newer version is available on the active channel, a yellow banner appears at the top of every page for admin users. The banner links to this page and can be dismissed for the current browser session by clicking ×.