Pluginframework
Breid de functionaliteit van Xcellerate RMM uit met community- en eigen plugins.
Overzicht
Met het Plugin framework breid je Xcellerate RMM uit met extra functionaliteit zonder het kernplatform aan te passen. Plugins kunnen nieuwe dashboardwidgets, eigen monitors, rapporttypes, integratieconnectoren en zelfs volledig nieuwe UI-pagina's toevoegen.
RMM Labs beheert een officiële plugin marketplace met plugins van de community en van RMM Labs zelf. Je kunt ook je eigen privéplugins ontwikkelen met de Plugin SDK en TypeScript/JavaScript.
Kernbegrippen
- Plugin — een op zichzelf staand uitbreidingspakket met een manifest, code en optionele assets (iconen, sjablonen). Wordt op serverniveau geïnstalleerd.
- Plugin marketplace — de ingebouwde catalogus waar je plugins bekijkt, installeert en bijwerkt. Bereikbaar via Administration → Plugins.
- Plugin SDK — een ontwikkelkit met API's om te werken met gegevens, UI-componenten en events van Xcellerate RMM. Beschikbaar als npm-pakket.
- Hook — een uitbreidingspunt in het platform waar plugins gedrag kunnen injecteren (bijv.
onEndpointCreated,onAlertFired,beforePatchInstall). - Widget — een component van een plugin die je kunt toevoegen aan het dashboard of aan de detailpagina's van endpoints (bijv. een eigen grafiek, een knop voor een snelle actie).
- Plugininstellingen — configuratiewaarden die de plugin aanbiedt (bijv. een API-key voor een externe dienst). Beheerders stellen die in na de installatie.
Stap voor stap
Bekijk de marketplace
Ga naar Administration → Plugins → Marketplace. Blader per categorie (monitoring, rapportage, integraties, UI) of zoek op naam. Elke pluginkaart toont een beschrijving, auteur, versie, beoordeling en aantal installaties.
Installeer een plugin
Klik op een plugin om de detailpagina te openen en klik daarna op Install. De plugin wordt gedownload en geactiveerd. Sommige plugins vragen een herstart van de server — de UI meldt het als dat nodig is.
Configureer de plugin
Ga na de installatie naar Administration → Plugins → Installed. Klik op de naam van de plugin en vul de vereiste instellingen in (bijv. API-keys, standaardparameters). Sla op.
Gebruik de plugin
Afhankelijk van het type plugin zie je een nieuw item in het zijbalkmenu, een nieuwe widget op het dashboard, extra opties in contextmenu's of een nieuw rapporttype. Raadpleeg de documentatie van de plugin voor details.
Werk een plugin bij of verwijder hem
Op de pagina Installed kun je controleren op updates (er verschijnt een badge wanneer een nieuwe versie beschikbaar is) of op Uninstall klikken om een plugin netjes te verwijderen.
Een eigen plugin ontwikkelen
Om je eigen plugin te bouwen, installeer je de Plugin SDK en zet je een nieuw project op:
npm install -g @xcellerate/plugin-sdk
xcellerate-plugin init my-custom-plugin
cd my-custom-plugin
npm run devHet gegenereerde project bevat een manifestbestand (plugin.json), een entry point en voorbeeldhooks. De SDK levert TypeScript-types voor alle platform-API's en een lokale ontwikkelserver die je plugin met hot reload test tegen een afgeschermde Xcellerate-instantie.
Tips en best practices
- Kijk eerst in de marketplace voor je zelf iets bouwt — misschien bestaat er al een plugin die doet wat je nodig hebt.
- Houd plugins up-to-date — auteurs lossen vaak bugs op en voegen functies toe in nieuwe versies.
- Volg bij het ontwikkelen van een eigen plugin het principe van minimale rechten: vraag alleen de API-rechten aan die je plugin echt nodig heeft.
- Test eigen plugins in een stagingomgeving voor je ze in productie zet.
- Gebruik hooks voor eventgestuurde logica (bijv. endpoints automatisch taggen bij het aanmaken) in plaats van de API te pollen.
- Dien nuttige plugins in bij de marketplace om ze met de community te delen en feedback te krijgen.