# Waldur Documentation

> Waldur is an open-source hybrid cloud platform for managing multi-cloud environments.
> It provides a unified interface for resource orchestration, service catalog management,
> and self-service portal functionality. Main components: MasterMind (backend API/orchestrator)
> and HomePort (web UI). Licensed under MIT.

## Getting Started

- [Introduction](https://docs.waldur.com/latest/): Platform overview, architecture, and main components
- [Getting Started](https://docs.waldur.com/latest/about/getting-started/): Quick start deployment guide
- [Screenshots](https://docs.waldur.com/latest/about/screenshots/): Visual overview of the platform UI
- [Terminology](https://docs.waldur.com/latest/about/terminology/): Glossary of Waldur-specific terms and roles

## Deployment

- [Architecture](https://docs.waldur.com/latest/admin-guide/architecture/): System architecture and component overview
- [Hardware Requirements](https://docs.waldur.com/latest/admin-guide/hardware-requirements/): Server sizing recommendations
- [Helm Deployment](https://docs.waldur.com/latest/admin-guide/deployment/helm/): Kubernetes deployment using Helm charts
- [Docker Compose](https://docs.waldur.com/latest/admin-guide/deployment/docker-compose/): Container-based deployment for development/testing
- [Production Checklist](https://docs.waldur.com/latest/admin-guide/checklist-for-production/): Pre-production verification steps

## Configuration

- [MasterMind Configuration](https://docs.waldur.com/latest/admin-guide/mastermind-configuration/): Backend configuration options
- [Features](https://docs.waldur.com/latest/admin-guide/mastermind-configuration/features/): Feature toggles and settings
- [Notifications](https://docs.waldur.com/latest/admin-guide/mastermind-configuration/notifications/): Email and notification setup
- [Billing](https://docs.waldur.com/latest/admin-guide/billing-and-accounting/): Billing and accounting configuration
- [Waldur Roles](https://docs.waldur.com/latest/admin-guide/waldur-roles/): Role definitions and permissions

## Identity Providers

- [Keycloak](https://docs.waldur.com/latest/admin-guide/identities/keycloak/): Keycloak SSO integration guide
- [LDAP](https://docs.waldur.com/latest/admin-guide/identities/ldap/): LDAP/Active Directory integration
- [FreeIPA](https://docs.waldur.com/latest/admin-guide/identities/freeipa/): FreeIPA identity management
- [eduGAIN](https://docs.waldur.com/latest/admin-guide/identities/edugain/): Research and education federation

## Cloud Providers

- [OpenStack](https://docs.waldur.com/latest/admin-guide/providers/openstack-setup/): OpenStack cloud integration
- [Azure](https://docs.waldur.com/latest/admin-guide/providers/azure/): Microsoft Azure integration
- [SLURM](https://docs.waldur.com/latest/admin-guide/providers/slurm-setup/): HPC SLURM cluster integration
- [Remote SLURM](https://docs.waldur.com/latest/admin-guide/providers/remote-slurm/): Remote SLURM via Site Agent
- [Site Agent](https://docs.waldur.com/latest/admin-guide/providers/site-agent/): Remote site management agent for distributed deployments

## API Integration

- [Authentication](https://docs.waldur.com/latest/integrator-guide/APIs/authentication/): API token-based authentication
- [Permissions](https://docs.waldur.com/latest/integrator-guide/APIs/permissions/): Role-based access control for API
- [API Overview](https://docs.waldur.com/latest/integrator-guide/APIs/api/): REST API structure and conventions
- [API Lifecycle](https://docs.waldur.com/latest/integrator-guide/api-lifecycle/): API versioning and deprecation policy
- [Python SDK](https://docs.waldur.com/latest/integrator-guide/sdk/): Official Python SDK installation and usage
- [Project Examples](https://docs.waldur.com/latest/integrator-guide/APIs/project-api-examples/): Common API usage patterns

## Developer Guide

- [Development Setup](https://docs.waldur.com/latest/developer-guide/guides/install-from-src/): Local development environment setup
- [Architecture](https://docs.waldur.com/latest/developer-guide/core-concepts/): Core concepts and system design
- [Marketplace](https://docs.waldur.com/latest/developer-guide/core-concepts/marketplace/): Marketplace architecture and offerings
- [Permissions](https://docs.waldur.com/latest/developer-guide/core-concepts/permissions/): Permission model internals
- [Background Tasks](https://docs.waldur.com/latest/developer-guide/core-concepts/background/): Celery tasks and background processing
- [UI Development](https://docs.waldur.com/latest/developer-guide/ui/): HomePort React frontend development

## User Guide

- [Project Management](https://docs.waldur.com/latest/user-guide/customer-organization/project-management/): Creating and managing projects
- [Resource Management](https://docs.waldur.com/latest/user-guide/customer-organization/resource_management/): Provisioning and managing cloud resources
- [Usage Reports](https://docs.waldur.com/latest/user-guide/customer-organization/usage_reports/): Viewing usage statistics and costs
- [Credit Management](https://docs.waldur.com/latest/user-guide/customer-organization/credit-management/): Managing organization credits
- [Service Provider](https://docs.waldur.com/latest/user-guide/service-provider-organization/): Becoming and managing a service provider
- [Staff Administration](https://docs.waldur.com/latest/user-guide/staff-users/): Platform administration for staff users

## Integrations

- [Waldur MCP Server](https://docs.waldur.com/latest/integrations/waldur-mcp-server/): Model Context Protocol server for AI assistants
- [Open OnDemand](https://docs.waldur.com/latest/integrations/openondemand/): HPC portal integration
- [Keycloak Mapper](https://docs.waldur.com/latest/integrations/waldur-keycloak-mapper/): Keycloak attribute mapping plugin
- [LEXIS](https://docs.waldur.com/latest/integrations/lexis/): LEXIS platform integration

## Optional

- [API Reference](https://docs.waldur.com/latest/api-reference/): Complete REST API documentation with 270+ endpoints
- [API Changelog](https://docs.waldur.com/latest/integrator-guide/APIs/api-changes/): API schema diffs between versions (7.4.8 - 7.9.x)
- [Release Notes](https://docs.waldur.com/latest/about/CHANGELOG/): Version changelog with detailed release notes
- [Ansible Modules](https://docs.waldur.com/latest/integrator-guide/ansible/): Ansible collection for Waldur automation
- [Contributing](https://docs.waldur.com/latest/about/contributing/): Contribution guidelines for developers