Documentation / Getting Started

Getting Started

This guide starts where installation ends: the container is up and the login page is open. By the end you have one router reporting into the dashboard.

1. First login

Not installed yet? Start with the Installation guide and come back here.

The first administrator is created by the manager itself, on first start — there is no command to run. It is the user admin with the password admin and the superadmin role.

That only happens while the database has no users at all. Once an account exists it is never recreated, so a later restart cannot reset a password you have already set — and an admin you delete stays deleted rather than reappearing on the next start.

Open the manager on port 3000 and log in with those credentials. The first sign-in with the default password opens a Set a new password screen, and nothing else opens until you have chosen one. If you set INITIAL_ADMIN_PASSWORD before the first start, the account gets that password instead and there is nothing to change. (v1.97.0+)

Pick a password you do not use anywhere else. The manager stores your routers' credentials encrypted, and this account can use them. You can change it again later under Settings → Password.

2. Create a site

A site is a group of devices — normally one physical location. Create it before the first device: sites are what the dashboard groups by, and they are also the unit that per-user access is granted on, so a device added to the right site from the start needs no rearranging later.

Go to Sites → Add Site. Only the name is required:

FieldNotes
NameRequired. Shown as the group heading on the dashboard and the devices page.
LocationOptional. Free text, searchable.
DescriptionOptional. Free text, searchable.
User accessWhich users may see this site's devices. The block appears for a superadmin and lists the users who are limited to specific sites — anyone not limited already sees every site. Leave it alone for now and come back once you have more than one user.

If you only manage one location, still create one site. Devices without a site work, but they collect in a group called Ungrouped at the end of every list, and a user scoped to specific sites cannot see them at all.

3. Create the RouterOS account

Do not point the manager at your admin account. Create a dedicated user on the router with a group that carries only the policies the manager actually uses. On the router:

/user/group/add name=manager-group policy=ssh,reboot,read,write,sensitive,rest-api,policy,!local,!telnet,!ftp,!test,!winbox,!password,!web,!sniff,api,!romon
/user/add name=mikr group=manager-group password=YOUR_PASSWORD

This limits the damage if the manager itself is ever compromised. The negated policies are deliberate — leave them negated unless you know why you need one of them.

Read-only accounts

An account without the write policy is supported and is a reasonable choice if you only want monitoring. The manager detects it: the device card carries a read-only badge, its page notes which account it is, and Test Connection reports it — so you find out when you add the device, rather than when an upgrade or a backup is rejected months later.

Monitoring, interface and neighbour data all work on such an account, and so do read commands and configuration exports, which need no write permission on the router. What the manager refuses outright on a read-only account is a RouterOS or firmware upgrade and a VLAN or bridge change: the router would reject them anyway, and it says so before spending a reboot window on it. Anything else that changes the configuration is rejected by the router itself when it runs.

4. Choose a connection method

Each device is configured with one method. This is the difference between them:

Your devices need RouterOS 7. RouterOS 6 is legacy: it is out of scope, not tested and not supported, SNMP included. A 6.x device can still accept the login and pass Test Connection, because that is all the test proves, and then show nothing on its page.
CapabilitySSHREST APISNMP only
Status monitoringyesyesyes
Interface and neighbour datayesyesyes
CLI commandsyesyesno
RouterOS and firmware upgradesyesyesno
Configuration backupyesyesno
RequiresRouterOS 7, SSH service enabledRouterOS 7.1+, www-ssl or wwwRouterOS 7, an SNMP community

SSH is used for reading even on REST devices

This surprises people, so it is worth stating plainly. Whatever method a device is set to, the manager reads over SSH and only sends writes over the configured method. The reason is a MikroTik behaviour: the REST API creates an entry in /user/active roughly every ten minutes, and those entries are never cleaned up — left alone for long enough they exhaust the router's session slots. An SSH connection creates one session that goes away when it disconnects.

If SSH is not reachable on a REST device, the read falls back to REST, so the device still works. But plan your firewall rules on the assumption that the manager needs SSH to the router.

There is one way to change that, and it is off until you ask for it: a device with an SNMP community can have its routine polling moved to SNMP, either for that device alone or install-wide. Commands, upgrades and the detail tabs still open SSH or REST when you use them. That is the Monitoring transport field in the next step.

What an SNMP-only device gives you

Choose SNMP when SSH and REST are not available or not wanted on a device. Over SNMP the manager reads the RouterOS version, uptime, CPU load, free and total memory, board name and model, serial number, current and upgradeable firmware, temperature, voltage, power consumption, the device identity, the interface list with neighbours, and interface traffic counters.

It cannot run commands, upgrade, or take backups — there is no SNMP for those. An SNMP-only device is a monitoring target, not a managed one.

SNMP can also be added to an SSH or REST device as a supplementary source, which is a different thing from SNMP-only — see Monitoring transport in the next step.

5. Add your first device

Go to Devices → Add Device. The form is longer than it needs to be for a first device: only the first block matters, the rest has working defaults.

  1. Identity. Name and Host / IP are the only required fields. Pick the Site you just created. If that site carries a backup policy, the form offers to put this device on the same schedule; clear the box to keep it off.
  2. Connection. Connection Method — SSH, REST API or SNMP Only. API Protocol is HTTPS by default and only applies to REST. SSH Port defaults to 22 and API Port to 443; both defaults can be changed globally under Settings for all new devices, and a per-device value always wins.
  3. Credentials. Username is the RouterOS account you created in step 3. Auth method is either a password or an SSH key — choosing the key shows a field for the private key in PEM form. For SNMP Only, the SNMP Community is required instead; the SNMP Port defaults to 161. On SSH and REST devices a community is optional and enables SNMP as an extra source.
  4. Everything else can stay as it is. Monitoring transport decides how routine polling runs and defaults to following the global setting; actions and detail tabs still open SSH or REST on demand. Poll interval empty means the system default of 60 seconds, and the minimum you can set is 10. Tags, notes, IDS auto-block, log retention, LTE limits, the PoE budget override and per-device metric thresholds are all optional and easier to decide once the device is reporting. PoE-out supply is worth a moment on a switch or router that feeds powered devices: pick the MikroTik supply it runs on, or type the volts and amps of any other one, and the manager works out the budget from there. Left empty, a PoE switch uses its model's datasheet figures, while a board that delivers at whatever voltage it is fed — hEX PoE among them — has no ceiling until this is filled in. The next section lists every field with its default.
  5. Test the connection. Save, then run Test Connection on the device. It performs a real read of the system information, so a success means the credentials, the port and the account's policies are all genuinely working — not just that the host answers.

Once one device works, the bulk paths are worth knowing: Scan discovers devices on an IP range, written either as 192.168.1.0/24 or as 192.168.1.1-254, and the devices page can Import a bundle exported from another install — passphrase-protected, and devices it already has are skipped. Get the first one right by hand first — the same credentials mistake repeated across thirty devices is no fun to undo.

6. Every field on the device form

The walkthrough above gets one device reporting. This is the reference for the rest of them — what each field does, and what happens if you leave it alone. Almost everything is optional, and a field left empty follows a global setting rather than switching something off.

FieldWhat it doesLeft empty
NameWhat this device is called everywhere in the manager. Yours to choose — it does not have to match the RouterOS identity, which is read from the device and shown next to it.Required
Host / IPThe address the manager connects to. IPv4, IPv6 or a hostname it can resolve.Required
SiteWhich site the device belongs to. Sites are what per-site access is scoped by, so this decides who can see it.Ungrouped — a user scoped to specific sites will not see it unless they are an admin
Back up on the site scheduleOnly on the Add form, and only when the site you picked is covered by a backup policy. Ticked, the new device joins that schedule; cleared, it is recorded as opted out, so a later edit of the site policy does not quietly re-attach it.Ticked
Connection MethodSSH, REST API or SNMP Only. See section 4 for what each one can and cannot do.SSH
API ProtocolHTTPS or HTTP for REST devices. Ignored on SSH and SNMP devices.HTTPS
SSH PortPort for SSH.The default under Settings → Defaults, which ships as 22
API PortPort for the REST API. RouterOS 7 serves REST on www/www-ssl, ports 80 and 443 — not on the old api ports 8728/8729.The default under Settings → Defaults, which ships as 443
UsernameThe RouterOS account from section 3.Required, except on SNMP Only
Auth methodA password, or an SSH private key in PEM form. Either one is encrypted at rest with AES-256-GCM and is never shown again after saving.Password
SNMP CommunityRequired on SNMP Only. On SSH and REST devices it is optional and adds SNMP as a second source of readings.No SNMP
SNMP PortUDP port for SNMP.161
Monitoring transportHow routine polling runs for this device: follow the global setting, force SNMP, or never use SNMP. Actions and detail tabs still open SSH or REST on demand whichever you pick.Follow the global setting, which ships as SSH
TagsFree labels. Searchable, usable to pick devices for a mass command, and a webhook can be limited to them. An assistant can find devices by them too.None
NotesFree text, shown on the device page below the tags. The search on the Devices page matches it, and an assistant can find devices by it too.None
EnabledOn the Edit form only; a device is enabled when it is added. Off means the manager stops polling this device entirely. It stays in the list, badged Disabled, and is left out of the counts of what is online or down.Enabled
Auto-block (IDS)Lets the manager add the source of repeated failed logins to a firewall address-list on this device. Opt-in per device because it writes to the configuration.Off
Poll intervalSeconds between polls for this device. Lower it for something you watch closely, raise it for a device on a slow or metered link. The minimum is 10.The global interval, which ships as 60 seconds
Traffic history interfacesInterface names, separated by commas, whose traffic goes into the one-minute history. Names must match RouterOS exactly, capitals included. Useful on a router with hundreds of VLANs, where recording every one fills the disk. The live traffic view still shows every interface. (v1.97.0+)Empty: every interface is recorded
Log retention (rows)How many syslog lines to keep from this device, up to 1,000,000.The global syslog setting
Log retention (days)How long to keep them, 1 to 3650 days.The global syslog setting
Monthly LTE limit (GB)The plan's monthly allowance. The manager accumulates LTE transfer from its own polls and fires a warning webhook as it approaches the limit, and an alert at 100%. It is an approximation from polling, not the carrier's own balance.No limit, no warnings
Owner phoneCarried in the alert webhook payload so an external SMS bridge can route the message. The manager does not send SMS itself.The global fallback number, if one is set
PoE-out supplyWhich power supply feeds the device: a MikroTik supply by name, or the volts and amps of any other. It is one or the other — choosing a catalogue supply clears a typed pair, and vice versa, because two sources for one ceiling is how a number nobody can trace appears. This is what makes a budget possible at all on routers whose PoE ceiling follows the brick, and it caps a switch that could otherwise pass more than the supply allows. The manager also checks what you chose here against the voltage the board reports, and says so on the PoE card if the two are from different voltage classes — which usually means the supply was changed and this field was not.The model's own datasheet figures, and on a router that bundles a supply, the bundled one. On a board that passes its supply straight through to the powered ports, no ceiling at all until this is set
PoE budget (W)A hand-set ceiling that overrides everything above, for a case the catalogue does not cover. Shown only on devices that already have one, so it can be cleared.Worked out from the model and the supply
Metric alert thresholdsCPU (0-100%), memory (0-100%) and temperature (0-150 °C) for this device alone. A value here wins over the global threshold, and 0 switches that metric off for this device even when the global one is set.The global thresholds under Settings → Metric alerts
ISP linksWhich interfaces face your providers. By default they are read from the interface comments on the router: ISP1, isp-2, ISP3 LTE, where the text after the number is the provider's name. Set here replaces the comments with a list of your own, a number and an interface per line. The number only tells links apart. See ISP links. (v1.98.0+)Read from the interface comments
Alert when an ISP link's address changesSends the ISP Address Changed webhook and writes it to the activity log when the address on one of this device's ISP links changes. (v1.98.0+)No
Nothing in this table has to be right on the first save. Every field is editable afterwards from the same form, and the only ones that change how the manager reaches the device — address, method, ports, credentials — are worth re-running Test Connection after.

7. Check that it works

The manager polls every device on a schedule; the default is once every 60 seconds. Within about a minute the device should carry a green Online badge and show its RouterOS version, uptime, CPU and memory.

The badge has five states, and telling them apart saves time:

BadgeMeaning
OnlineThe last poll succeeded.
Not accessibleThe poll failed, but the management port still accepts TCP connections. Something answers at that address — usually the device with its management session wedged — see Troubleshooting.
Other deviceA router answers at this address, but its serial number is not this device's — see Troubleshooting (v1.96.0+).
OfflineThe poll failed and the management port does not answer either.
UnknownNot polled yet.
DisabledMonitoring is switched off for this device.

On the device page, expect some sections to be empty. A router with no wireless has no wireless clients, a board with no health sensors reports no temperature, and a CHR has neither. An empty tab usually means the hardware does not have that feature, not that the read failed.

8. Where to go next

In rough order of how much they pay back:

  • Backups — schedule configuration exports before you need one.
  • Upgrades — check the fleet for RouterOS and firmware updates in one pass.
  • Users and access — roles, per-site scope, and a second factor on the login. Worth reading before the second person gets an account.
  • Webhooks — send device-down and threshold events to whatever you already watch, held for a few minutes first if a flapping link would otherwise wake someone.
  • Topology — the map of what each device sees of the others, once you have more than a couple in a site.
  • Metrics — the Prometheus export for long-term graphs, or the Zabbix template if that is what you run.

If something does not look right, Troubleshooting covers what the symptoms actually mean.