NetLock RMMNetLock RMM Docs
IV — Administration

System overview & licensing

System health monitoring, the public backend URL, licence status and the Members Portal API key for self-hosted deployments.

System overview & licensing

Self-hosted only: This chapter is written for self-hosted deployments. On cloud, the hosted operations team runs the deployment and manages licensing: Settings → Overview shows only the Public console URL panel, and the Licensing entry is hidden, so opening /settings/licensing directly returns to the dashboard.

This chapter covers two administrative pages that show the deployment operator how the system is performing and what the current licence allows. Both are mostly read-only: the System Overview page is read-only apart from three settings, the System Storage Limit, the public backend URL and the public console URL, and the Licensing page is read-only apart from replacing the Members Portal API key. Connection strings are never editable in the Console; they are changed outside it, in appsettings.json.

A.1.1 System Overview

Settings → Overview at /settings/overview is the place to check first when you want to know at a glance whether everything is healthy. It is almost entirely a monitoring page and shows the live state of the four subsystems a self-hosted NetLock RMM deployment depends on, using the same data the agents and backend services use to do their work. The exceptions are the System Storage Limit, Public backend URL and Public console URL panels, each of which carries a single editable setting; everything else on the page is read-only.

System Overview page showing MySQL, Web Console, File Server, and Remote Server panels

The MySQL section

The database section answers two questions: is the database reachable, and is it under load. A status icon at the top of the section turns green when the Console has an active connection to MySQL and red when it does not. The panel reports:

  • Version: the MySQL server version string.
  • Uptime: elapsed seconds since the MySQL instance started.
  • Active connections: the number of sessions currently open against the server.
  • Database size: total size of the NetLock RMM database, in bytes.
  • Max connections: the configured upper limit for concurrent sessions.
  • Failed logins: a running count of authentication failures since the database started.

Below those counters, a searchable table lists every active query the database is currently executing. Columns are Id, User, Host, Database, Command, Time, State, and Info. Open this view first when the Console feels slow. A long-running query or a connection pile-up often shows up here before it shows up anywhere else.

The Web Console section

Three cards summarise how much resource the machine hosting the Web Console is using right now:

  • CPU usage: a percentage with a progress bar.
  • RAM usage: a percentage with a progress bar, plus a Used / Free / Total breakdown in GB.
  • Disk usage: a percentage with a progress bar, plus a Used / Free / Total breakdown in GB.

The values are sampled from the Web Console host, not from any individual managed device. Use the section as an early warning when the Console itself is about to run out of headroom. A sustained high CPU number on this panel means the host needs more resources; the managed devices are not involved.

System Storage Limit

The System Storage Limit panel caps how much data NetLock RMM may store on disk. The on-screen description states this covers the devices/ and internal/ folders together with the MySQL database size.

A usage card shows current consumption as <current> GB / <limit> GB with a progress bar that shifts from green to amber at 90% and to red at 100%, plus a line reporting how many GB remain.

A second card carries the editable control: a Storage limit (GB) numeric field (1 to 999999) and a Save button. Set the value and save it to change the cap.

When consumption crosses a threshold, the Console opens a dialog automatically: a warning at 90%, and at 100% a limit-reached dialog that cannot be dismissed by clicking away until you free space or raise the limit.

File Server and Remote Server status

Two smaller panels report the Console's ability to reach the other two backend services in a NetLock RMM deployment.

  • NetLock RMM File Server: shows Connected when the Console can talk to the File Server, Not connected otherwise. The File Server is responsible for agent downloads, script artefacts, and attachment storage.
  • NetLock RMM Remote Server: shows Connected when the Console can talk to the Remote Server, which handles remote control sessions and relay. A failed check here is accompanied by a PTR-mismatch warning when the probable cause is a reverse-DNS misconfiguration; the warning includes a link to the relevant documentation.

If either panel shows Not connected, use the Check again action at the top of the page to re-run the connectivity probe without reloading the entire page. Check again only retests the two service endpoints and updates their status chips, so during an incident you keep any search you have already typed into the MySQL active-queries table.

A persistent Not connected state on either service is a signal to check the service's own host. For the File Server, confirm the service is running and that the Console host can reach it on its configured port; for the Remote Server, confirm the service is running and the public DNS record resolves, including a matching PTR record.

Public backend URL

The Public backend URL panel holds the address under which agents and browsers reach the installation from outside, for example https://rmm.example.com. The Console uses it for agent installer and download links, remote screen control and web access sessions; the server uses its host part over HTTPS for the same purposes. When no URL is set, the configured File Server and Remote Server addresses are used instead. The value is the same one that Webinterface:PublicOverrideUrl in the Console's appsettings.json carries; because that file is encrypted after the first start, this panel is the place to change it.

The first card shows the URL the running Console uses (Active URL, or Not configured). The second card, shown only to accounts with settings_overview_manage, takes a new URL. The field accepts a scheme, a host and an optional port (https://rmm.example.com or https://rmm.example.com:8443), with no path, query or fragment. Trailing slashes are removed; otherwise the value is stored as typed, so a port such as :443 is kept. Save asks for confirmation and stores the URL; Clear URL (offered while a URL is stored) removes it after confirmation. Both actions write an audit entry with the previous and the new value.

A saved change does not take effect immediately. The running Console keeps its URL and the panel shows a Restart required notice with the change until the web console and the server have been restarted:

docker compose down
docker compose up -d

Without Docker, restart the NetLock RMM Web Console service and every NetLock RMM Server service.

On start, the Console compares the stored URL with the one in its appsettings.json:

  • A file value the Console wrote itself yields to the stored value, so a URL saved or cleared on this page becomes the active one and is written back into the file.
  • A URL entered into appsettings.json by hand takes precedence and is written to the database.
  • An empty file value never removes a stored URL. Use Clear URL for that.

The server reads the stored URL when it starts. A value saved on this page is already in the database when the stack restarts, so the start order does not matter. After you edit the URL in appsettings.json by hand, restart the Console first and then the server.

The Console writes appsettings.json in place, so the file keeps its owner and permissions. It has to be writable for the user the Console runs as. In a Docker installation that is user 1654: the guided installer sets the ownership when it creates the file, and on a host with the compose file from the manual installation guide the container takes ownership at start (see Running the containers as an unprivileged user).

If the file could not be written at the last start, the panel shows a notice, and the URL in the file takes precedence on every start until the file is writable again. The same applies to the other settings the Console writes into the file (the logging switch, the Members Portal API key, the membership reminder), which report a failed write instead of appearing saved.

Public console URL

The Public console URL panel holds the address under which people reach the web console, for example https://console.example.com. Links into the console are built from this value and from nothing else: the {{url}} placeholder of ticket webhooks and the Open ticket line of ticket notification mails, for tickets created in the console as well as through the public API, from the tray icon or from a device.

While no URL is set, {{url}} is empty and notification mails contain no link. Webhooks and mails are sent as usual. The panel, the Webhooks dialog, the Notifications section of a department and Settings → Ticket System show a notice until a URL is set.

The panel is visible with settings_overview_enabled; changing the value needs settings_overview_manage. Use this browser's address copies the address the page is open under into the field, Save asks for confirmation and stores it, and Clear URL removes it after confirmation. The field accepts a scheme, a host and an optional port, as for the public backend URL. Both actions write an audit entry with the previous and the new value. No restart is needed: the Console uses a saved value at once, and a running server picks it up within a minute. The value is stored in the database only; a self-hosted installation has no appsettings.json key for it.

On cloud, the address of your instance is filled in for you and follows a custom domain when it goes live or is removed. A URL you save yourself stays in place until you clear it. After Clear URL NetLock Cloud fills in the address of your instance again, at the latest at the next start of the web console, so on cloud the panel cannot stay empty for good.

Settings outside the page

Apart from the System Storage Limit, the Public backend URL and the Public console URL, the Overview page is read-only. Its interactive controls are the Save buttons for these settings, Clear URL, Use this browser's address, and the Check again button for the service connectivity probes. To change any of the monitored values (MySQL connection string, File Server URL, Remote Server URL), edit appsettings.json on the Console host and restart the Console. Connection strings belong to the deployment, not to the runtime configuration, so the Console has no editor for them.

A.1.2 Licensing

Settings → Licensing at /settings/licensing reports the status of your NetLock RMM licence against the Members Portal. Like Overview, this page is mostly read-only. Besides refreshing the licence information, the only thing you can change here is the Members Portal API key.

Licensing page showing an Active badge, X / Y licence count, and the Upgrade button

Members Portal API key

The API Configuration section at the top of the page shows the key the Console currently runs with as Active API key, masked down to its last four characters, or No API key configured. The full key is never shown.

Accounts with settings_licensing_manage also see a New API key field and a Replace API key button:

  1. The Console checks the new key against the Members Portal. A key the Members Portal does not accept (unknown, or belonging to a banned, expired or inactive membership) is not saved. If the Members Portal cannot be reached, the Console asks whether to save the key anyway.
  2. The key is stored encrypted in the database. The audit log records the change with the last four characters of the previous and the new key.
  3. The page shows Restart required with the masked new key, the Docker commands to restart the services, and a copy button. The web console and the server keep running with the current key until they are restarted; on start they adopt the new key and fetch the licence and the agent packages for it.

The full procedure, including the fallback through appsettings.json, is in Replace the Members Portal API key.

License status

The second section summarises the licence itself:

  • A status badge: Active (green) when the licence is in good standing, Expired (red) when it has lapsed.
  • The licence name, which reflects the tier you are subscribed to.
  • A code-signing row. When code signing is included in your tier, the line reads Code signing enabled. When it is not, the line reads Code Signing not available with the sub-text Available from Tier 1 for professional deployments. Code signing determines how managed devices trust agent installers.
  • A licence-count row shown as X / Y with a progress bar, where X is the number of seats you are currently consuming and Y is the total you are licensed for. Only approved devices consume seats. Unauthorised devices (see Chapter 3.2) do not count until they are approved.

Actions

  • Replace API key: in the API Configuration section, shown only with settings_licensing_manage. See Members Portal API key above.
  • Refresh License Information: re-fetches the licence record from the Members Portal. The button is disabled when no API key is configured. Use this after adding seats or upgrading a tier. The Console caches the licence state and does not re-query it automatically. The button updates only the Web Console; the server loads its licence when it starts. After a renewal of a licence that had already run out, follow Reload licence information after a renewal.
  • Upgrade: shown only when code signing is not available for your current tier. The button opens https://www.netlockrmm.com/pricing in a new tab so you can compare plans. Upgrades are handled on the pricing page and through your account manager, not inside the product.

Billing and plan changes

Billing is not shown in the product. To change the plan, use the pricing page or the Members Portal, then come back to the Licensing page and click Refresh License Information to pull the updated status. A replaced API key does not take effect before the web console and the server have been restarted.

Cross-reference

Licensing settings are not accessible on cloud deployments, because the cloud team handles billing and licensing centrally. The navigation entry is hidden, and opening the page directly returns to the dashboard.

Permissions

PageRequired flags
Settings → Overviewsettings_enabled, settings_overview_enabled
Change the storage limit, the public backend URL or the public console URL on Settings → Overviewsettings_enabled, settings_overview_enabled, settings_overview_manage
Settings → Licensingsettings_enabled, settings_licensing_enabled
Replace the API key on Settings → Licensingsettings_enabled, settings_licensing_enabled, settings_licensing_manage

The listed flags must be set on a user's permission matrix (see Chapter 14) for the corresponding page to appear in the navigation, or for the action to be offered.

  • Chapter A.3 — Database management. The Overview page reports MySQL health; A.3 is where you configure retention and run optimisation.
  • Chapter A.2 — Updates & maintenance. The concurrency cap that governs agent installers lives there.
  • Chapter 14 — Users & Roles. Where you grant settings_enabled and the per-page flags.
  • Chapter 9 — File Server & Monitoring. Covers the File Server and Relay Server services the Overview page probes.