Documentation
These pages are the docs that ship in the repository, published as they are. Start with the install guide: it takes a fresh Ubuntu VM to a signed-in Admin with backups running.
Get started
From a fresh VM to a signed-in Admin, then discovery from Microsoft Entra ID.
- Install SoftwardenTake a fresh Ubuntu Server 24.04 VM to a signed-in Admin with backups running, using Docker Compose.
- First run: set up Microsoft Entra discoveryCreate the Entra app registration and the connection, then run the first discovery and fill the Discovery queue.
- Editions and capabilitiesWhich features each edition includes, how the API gates them and how an operator sets the edition.
Reference
Settings, permissions and the interfaces other tools use.
- Environment referenceEvery environment variable Softwarden reads, its default, which service reads it and whether it is a secret.
- Microsoft permissionsEvery Microsoft Graph, Azure, Dataverse and Exchange permission Softwarden requests, and which feature needs it.
- The Softwarden APIWhat every endpoint under /api/v1/ shares: authentication, tokens, pagination, errors, ETags, rate limits and webhooks.
- Catalog as codeExport the catalog as YAML files for a git repository, then plan and apply changes from pull requests.
- The Softwarden MCP serverLet an AI assistant read the catalog through the REST API with your token, with opt-in guarded writes.
Operations
Keeping an installation backed up, upgraded and healthy.
- Back up and restore SoftwardenNightly encrypted backups from the worker, the backup key, restores and the restore rehearsal.
- Upgrade Softwarden on the pilot VMUpgrade an installation: a fresh backup, a pinned image, the pre-check, forward-only migrations and checks.
- Operations: logs, health and tracesJSON logs with request ids, /readyz for monitors, /healthz/ops for operators and optional traces.
- Recover from a broken single sign-on configurationRecover from a broken single sign-on configuration from the host. Password sign-in is never removed.
- SCIM provisioning runbook (enterprise)Set up SCIM provisioning of users and groups from Microsoft Entra ID (enterprise).