Documentation
Guides for installing, configuring and running RivetIT and RivetMSP. They are read live from each project's GitHub repository, so they always match the code.
Getting started
First-time setup
The browser installer: connect the database, create the first administrator and set language, currency and time zone. About five minutes.
Read guide RivetITGetting started
Sign in, find your way around, set up your account and learn the list features almost every page shares.
Read guide RivetMSPGetting started with RivetMSP
What an install is made of, your first hour, and where to go next.
Read guide RivetMSPInstalling RivetMSP
Docker Compose to try it, or the install script for a hardened production server, with worked examples.
Read guideDeploying & administering
Deployment (Docker or bare metal)
Choose between the two supported install paths, and how backup, disaster recovery and updates work end to end.
Read guide RivetITAdministration: users, roles and security
Who can sign in and what they can do, MFA, API keys, and the audit, app and email logs.
Read guide RivetITAdministration: settings, mail and maintenance
Modules, company details, mail in and out, connected services, backups and keeping the system running.
Read guide RivetITAdministration: ticketing and automation
Statuses, SLAs, templates, canned responses, the request catalog and automation rules.
Read guide RivetMSPBackups and disaster recovery
Encrypted scheduled backups, restoring onto a new server, and testing a restore safely.
Read guide RivetMSPHardening and security checklist
The hardening pass, what it changes, and the four things every install should do.
Read guide RivetMSPUpdating RivetMSP
Pull updates, run database migrations one step at a time, and what to check afterwards.
Read guide RivetMSPCron Manager
Enable background jobs, pick a schedule from the web, and see what runs.
Read guide RivetMSPRivetMSP deployment scripts
install.sh, backup.sh, restore.sh and hardening, with every flag and worked examples.
Read guideUsing the platform
Dashboard and reports
The landing dashboard, how reports work, date ranges, permissions and scheduled report e-mail.
Read guide RivetITReport reference
Every report: the question it answers, its filters, how to read each figure and what you can export.
Read guide RivetITProjects and calendar
Group tickets and tasks into projects with milestones, Kanban and Gantt, and use the shared team calendar.
Read guide RivetITDepartment Portal
How employees raise tickets, request services and read articles, and how staff set the portal up.
Read guide RivetITTraining: courses and content
Build, preview and publish courses and required documents.
Read guide RivetITTraining: quizzes, paths and badges
Quizzes and final exams, the question library, learning paths and achievements.
Read guide RivetITTraining kiosk device setup
Turn an iPad or Windows PC into a shared training device with name and PIN sign-in.
Read guide RivetITOrganisation chart
Access, filters, hierarchy context and navigation for the org chart.
Read guide RivetMSPUsers, roles and client access
Roles and module permissions, limiting technicians to clients, portal access and two-factor sign-in.
Read guide RivetMSPTurning features on and off
The company-wide switches for accounting, the knowledge base, live chat, RMM and more.
Read guide RivetMSPTicket automation rules
Triggers, conditions and actions that handle routine ticket work for you, with example rules.
Read guide RivetMSPScheduling and calendars
Appointments, the dispatch calendar, Outlook sync set-up and calendar subscription feeds.
Read guide RivetMSPContracts and SLAs
Response and resolution targets per priority, business hours calendars and billing frequency.
Read guide RivetMSPWorksheets and outtake forms
Checklist templates for technicians, finalizing, and customer sign-off.
Read guideIntegrations & sign-in
Endpoints and integrations
RMM, Intune, UniFi, Sophos Central and Comet: the screens, what you can do from them, and how data arrives.
Read guide RivetITOdoo Department Portal sign-in
Let employees enter RivetIT from Odoo without another password, using the rivetit_sso addon (Odoo 19 and 20).
Read guide RivetITCompany SSO with OpenID Connect
Sign in through Authentik, Keycloak or Ory Hydra using the authorization-code flow with PKCE.
Read guide RivetITRemote MCP (experimental)
An optional, off-by-default endpoint with read-only tools, protected by an external OAuth provider.
Read guide RivetMSPIntegrations
RMM, UniFi, Comet, email, QuickBooks Online, Stripe, Entra ID sign-in, webhooks and push.
Read guide RivetMSPThe RivetMSP Android app
Features, requirements, set-up and branding for technicians in the field.
Read guideReference
RivetIT REST API
The /api/v1 reference: authentication, resources and examples. Also used by the mobile app and RMM scripts.
Read guide RivetITRivetIT architecture
Code layout, sign-in and permissions, data model, module toggles, migrations and integrations.
Read guide RivetITISO/IEC 27001 control mapping
All 93 Annex A controls mapped against what RivetIT does and does not cover.
Read guide RivetMSPRivetMSP REST API
The narrative guide to the /api/v1 REST API that powers the Android app.
Read guide RivetMSPRivetMSP architecture
The admin, agent, client and guest portals, auth and permission model, data model, module toggles and integrations.
Read guideRivetMSP also follows the upstream ITFlow documentation for features it inherits.
Found something missing or unclear?
Documentation improvements are some of the most valuable contributions.