MantisRMM · Getting Started Guide

MantisRMM Getting Started

Last updated May 2026 · Applies to all MantisRMM tenants

This guide walks you through everything you need to get MantisRMM running — from installing your first agent to building automated remediation workflows. Follow the steps in order if you're new, or jump to any section using the sidebar.

Overview

MantisRMM is a cloud-native remote management platform that runs on Cloudflare's edge. There is nothing to install on your end for the management portal — it's a web application at rmm.mantisops.net. The only software you install is a lightweight agent on each managed endpoint.

Key concepts:

Concept	Description
Tenant	Your organization's isolated environment. All your agents, scripts, users, and settings live here.
Agent	A small background service installed on a managed endpoint (Windows, Linux, or macOS).
Company	A grouping of agents — typically represents a customer or business unit.
Group	A sub-grouping within a company — by role, location, OS, etc.
Site	A physical or logical network location used for organizing agents and network probes.
Script	A PowerShell, Bash, or Python script that can be run against agents manually or on a schedule.
Workflow	A multi-step automation that chains scripts, notifications, and conditions.

Install Agents

Agents are single-binary executables. They connect outbound to the MantisRMM API over HTTPS — no inbound firewall rules required.

Step 1 — Get your installer

Log in to rmm.mantisops.net, go to Settings → Agent Downloads, and download the installer for your platform. Each installer is pre-configured with your tenant credentials.

Step 2 — Install on Windows

Windows

Run the MSI installer as Administrator

Double-click the downloaded .msi file and follow the prompts. The agent installs as a Windows Service (MantisRMM Agent) and starts automatically.

Silent / GPO deployment

For mass deployment via Group Policy or SCCM, use the silent install flag:

msiexec /i mantisrmm-agent-windows.msi /quiet /norestart

Step 3 — Install on Linux

Linux

Download the shell script installer. It installs the agent binary to /usr/local/bin/mantisrmm-agent and creates a systemd service.

chmod +x mantisrmm-agent-linux-install.sh
sudo ./mantisrmm-agent-linux-install.sh

To check the agent status:

sudo systemctl status mantisrmm-agent

Step 4 — Install on macOS

macOS

Run the .pkg installer as an admin user. The agent installs as a Launch Daemon and starts at boot. You'll need to approve the System Extension in System Settings → Privacy & Security on first run.

Verify the agent is online

Within 30–60 seconds of installation, your endpoint should appear in the Agents list in the portal with a green "Online" status. If it doesn't appear after 2 minutes, check that the endpoint has outbound HTTPS (port 443) access to api.rmm.mantisops.net.

ℹ️Agents check in every 60 seconds by default. The check-in interval can be adjusted per agent in Agent Settings.

Companies & Groups

Companies let you organize agents by customer or business unit. Groups provide a second level of organization within a company — useful for separating workstations, servers, or locations.

Create a company

In the sidebar, click Companies → New Company
Enter the company name and an optional description
Click Save — the company appears immediately in the list

Create a group

Open a company → click Groups → New Group
Name the group (e.g., "Workstations", "Servers", "US-East")
Assign agents to the group either from the group settings or from each agent's Edit panel

Assign an agent to a company/group

Go to Agents, find the agent, click the three-dot menu → Edit. Select the company and group from the dropdowns. Agents can only belong to one company and one group at a time.

✅Best practice: Create one company per managed customer. Use groups to separate servers from workstations within each company. This makes it easy to apply scripts and policies to the right targets.

Users & Roles

MantisRMM supports multiple users per tenant with role-based access control.

Built-in roles

Role	What they can do
Admin	Full access — manage users, roles, agents, scripts, settings, and billing.
Technician	Access agents, run scripts, use remote desktop, manage patches. Cannot manage users or billing.
Read-only	View agents, script history, and reports. Cannot run scripts or make changes.

Invite a user

Go to Settings → Users → Invite User
Enter the user's email address and select their role
Click Send Invitation — they'll receive an email with a sign-in link

Scoped technicians (per-company access)

If you want a technician to only see agents belonging to a specific company, set their Company Scope when creating or editing the user. Scoped technicians cannot see agents from other companies.

⚠️Admin accounts have full access to all companies and settings. Keep the number of admin accounts to a minimum — use the Technician role for day-to-day work.

Remote Access

MantisRMM provides several remote access methods — each suited to different tasks.

Remote Desktop (Windows)

Click an online Windows agent → Remote Desktop. A new browser tab opens with a full desktop session. Features:

Bidirectional clipboard — copy/paste text between your machine and the remote endpoint
Branded notifications — a connect and disconnect toast is shown on the remote desktop so the end user knows someone is connected
Session sharing — share a session link with another technician (same tenant)

Remote Terminal / Shell

Available on all platforms. Click an agent → Terminal to open an interactive shell session directly in the browser:

Windows: PowerShell or cmd.exe
Linux: bash
macOS: zsh

File Manager

Browse the remote filesystem, upload files from your local machine, and download files from the endpoint — available on all platforms from the Files tab on the agent detail page.

Scripts & Automation

Scripts are reusable PowerShell, Bash, or Python programs you can run against one or multiple agents. They support variable substitution, agent field references, and custom field read/write.

Create a script

Go to Scripts → New Script
Enter a name, description, and select the language (PowerShell / Bash / Python)
Write your script in the editor. Use the Variables tab to add user-supplied variables and the Reference tab to see all available substitution tokens.
Click Save

Variable substitution

Three types of variables can be embedded in scripts:

Syntax	Type	Notes
`{{VARNAME}}`	User variable	Prompted when running manually. Define in the Variables tab.
`{{AGENT:hostname}}`	Agent field	Read-only. Populated automatically from the agent at runtime.
`{{FIELD:label}}`	Custom field	Readable and writable. Reads current value; write via stdout.

Available agent fields

Use these in scripts as {{AGENT:fieldname}}:

hostname, os, os_version, arch, ip, mac, agent_version, last_seen, platform

Writing back to custom fields

To update a custom field from a script, print a line to stdout in this format:

# PowerShell
Write-Output "MANTIS_FIELD:Asset Tag=ABC-12345"

# Bash
echo "MANTIS_FIELD:Asset Tag=ABC-12345"

✅You can write multiple fields in a single script execution — just print one MANTIS_FIELD: line per field.

Run a script against agents

From Scripts, click Run next to any script
Select target agents (individual, by group, or by company)
Fill in any required variables
Click Execute — results appear in real time in the Script Results panel

Workflow Automation

Workflows chain multiple steps together — scripts, conditions, delays, and notifications — and can be triggered on a schedule or manually.

Create a workflow

Go to Automation → Workflows → New Workflow
Add steps from the step palette: Script, Condition, Delay, Notification
For each Script step, select a saved script and configure variable overrides
Save the workflow

Workflow step types

Step	Description
Script	Runs a saved script against the workflow's target agent(s)
Condition	Branches workflow based on the previous step's exit code or output
Delay	Waits a specified number of seconds before proceeding
Notification	Sends an email or in-app alert

ℹ️Workflows run server-side — they continue even if you close the browser. Check progress in Automation → Run History.

Patch Management

MantisRMM provides Windows Update management and Winget software deployment from the portal.

Windows Update

From the agent detail page, click the Updates tab to see all pending Windows updates. You can install individual updates or run Install All to apply everything. Schedule automatic patching from Automation → Schedules.

Winget software management

From the Software tab on any Windows agent, you can:

View all installed software with version and publisher
Search the Winget repository and install packages silently
Uninstall software by name
See which installed packages have available updates

Schedules

Schedules let you run scripts or workflows automatically against agents on a recurring basis.

Create a schedule

Go to Automation → Schedules → New Schedule
Select the script or workflow to run
Choose target agents (individual, group, or company)
Set the recurrence: daily, weekly, monthly, or custom cron expression
Set the time (the portal uses your local timezone)
Save — the schedule is active immediately

✅Use schedules for recurring maintenance tasks: weekly patch checks, daily log cleanups, nightly compliance scans.

Alert Rules

Alert rules monitor agent status and notify you when conditions are met.

Available alert triggers

Agent offline — fires when an agent hasn't checked in after a configurable timeout
Agent came back online — fires when a previously offline agent reconnects
CPU / memory / disk threshold — fires when resource usage exceeds a set percentage
Script failure — fires when a scheduled script exits with a non-zero code

Create an alert rule

Go to Alerts → Rules → New Rule
Select the trigger type and configure thresholds
Enter one or more notification email addresses
Set the scope: all agents, a specific company, or a specific group
Save — the rule is active immediately

Agent Policies

Policies define configuration and compliance expectations for groups of agents. They are evaluated on every agent check-in.

Create a policy

Go to Policies → New Policy
Write the policy body in JSON — define expected values for agent properties
Set the Apply Interval (how often to re-evaluate)
Save the policy

Assign a policy to a group

In the Assignments tab of any policy, click Add Assignment and select a company or group. All agents in that group will be evaluated against the policy on check-in.

Custom Fields

Custom fields let you attach structured metadata to agents — asset tags, warranty expiry, owner names, location codes, and anything else your team needs.

Create a custom field definition

Go to Settings → Custom Fields → New Field
Enter a label (e.g., "Asset Tag"), field type (text, number, date), and an optional default value
Save — the field is immediately available on all agents

Set field values on an agent

Open an agent → Custom Fields tab → edit any field value inline. Values can also be written from scripts using the MANTIS_FIELD: output pattern (see the Scripts section).

Use field values in scripts

Read a custom field value inside a script with {{FIELD:label}}. The value is substituted at script execution time before the script is sent to the agent.

# Example: use "Asset Tag" custom field in a script
$tag = "{{FIELD:Asset Tag}}"
Write-Output "Running on asset: $tag"

Need help?

Submit a support ticket via our support page or email support@mantisops.net. We respond within one business day.