Plugin Developer Guide

Welcome to the Codumentor Plugin Developer Guide. This documentation covers everything you need to know about building, configuring, and distributing plugins for Codumentor.

Getting Started

• Overview — High-level introduction to the plugin system architecture
• Quick Start — Step-by-step tutorial to build your first plugin

Core Concepts

• API Routes — How plugins expose HTTP endpoints
• Backend Hooks — Server-side lifecycle integration points
• UI Components — Building custom web components for plugins
• User Gates — Per-user blocking modals (EULA, privacy updates, forced password change, …)
• Dependencies — Managing plugin dependencies
• Distribution — Packaging and distributing plugins
• File Links — File link integration

Best Practices

• Best Practices — Development best practices for robust plugins

Plugin Catalog

Browse the Plugin Catalog for documentation on all built-in plugins and how to configure them.