Getting Started
Welcome to the OpenCDMP documentation. Use the table below to find the right starting point for your role.
| I am… | Start here |
|---|---|
| A researcher or end user — I want to create and manage plans | User Guide |
| A tenant administrator — I want to configure blueprints, templates, and users | Admin Guide |
| A system administrator — I want to deploy or upgrade OpenCDMP | Deployment |
| Setting up authentication — I need to configure Keycloak | Keycloak Setup |
| Configuring services — I need to set environment variables | Configuration |
| A developer — I want to integrate with the API or build plugins | Developers |
What is in this section
This Getting Started section is aimed at system administrators who are deploying and configuring OpenCDMP. It covers:
- Introduction — Platform overview, core concepts, and key features
- Architecture — Microservices architecture and component breakdown
- Deployment — How to deploy OpenCDMP using Docker and how to upgrade
- Configuration — Environment variable reference for all services (backend, frontend, Keycloak, PostgreSQL, RabbitMQ, Elasticsearch)
- Common Workflows — Real-world use cases and workflow examples
First time deploying?
Start with the Deployment Guide to get OpenCDMP running, then follow Keycloak Setup to configure authentication. After that, the Admin Guide will walk you through setting up blueprints and templates so your users can start creating plans.