Skip to content

Docs / RivetMSP / Getting started

Getting started with RivetMSP

What an install is made of, your first hour, and where to go next.

RivetMSP is a single-tenant platform for managed service providers. One install serves one MSP company, which in turn manages many clients. It is a hardened, feature-extended build of ITFlow and you run it on your own server.

What is in the box#

An install is made of four cooperating portals that share one database:

Portal Who uses it What it is for
Agent Your technicians and staff Day-to-day work: tickets, clients, assets, credentials, documentation, projects, billing
Admin Agents whose role is an admin role Company settings, users and roles, integrations, cron, backups, database updates
Client Your customers' contacts A self-service portal for their own tickets, invoices and assets
Guest Anyone with an emailed link Approve a quote, pay an invoice or sign a document without an account

Admin is not a separate account type. An admin is an agent whose role has the admin flag, so there is one sign-in page for both.

Choose how to install it#

  • Docker Compose is the quickest way to try it. It runs nginx, PHP-FPM, MariaDB and Redis in containers. It is deliberately not hardened and has no TLS, so put a reverse proxy in front of it for anything beyond evaluation.
  • The install script (deploy/install.sh) provisions a whole Ubuntu or Debian box: packages, database, TLS, firewall, fail2ban, cron and the first-run setup. Use this for production.

Both are covered step by step in Installing RivetMSP.

Your first hour#

Once the setup wizard has created your administrator, work through this list. The first four matter for security and reliability, so do them before you add real client data.

  1. Turn on two-factor sign-in for the admin account. RivetMSP supports TOTP authenticator codes and passkeys (WebAuthn). Neither is enabled by default for the account the installer creates. See Users, roles and client access.
  2. Enable cron. The installer adds a system cron entry that runs every five minutes, but the application does nothing with it until you switch on Enable Cron in the app's settings. Recurring tickets, automation rules, RMM sync and scheduled reports all depend on it. See Cron Manager.
  3. Set up encrypted backups and store the passphrase somewhere other than the server. See Backups and disaster recovery.
  4. Run the hardening pass with deploy/harden.sh. See Hardening and security checklist.
  5. Decide which modules you need (accounting, knowledge base, live chat, RMM and so on) and switch the rest off. See Turning features on and off.
  6. Create roles and users for your technicians, then add your first client.
  7. Set up mail so tickets can be created from email and notifications can go out.

Where to go next#

This guide is maintained by Rivet IT Ops. Found a mistake? Tell us. RivetMSP on GitHub