# Licence and versions

> How licensing works on a self-hosted install, where to check it, and what governs limits.

> For the complete documentation index, see [llms.txt](https://helpdesk.orangescrum.com/llms.txt).

Source: https://helpdesk.orangescrum.com/guide/self-hosted/admin/licence

---
Self-hosted Orangescrum is a **commercially licensed** product. The licence is
verified during installation and stored with your instance.

## Where to check it

**Subscription & Plan** in the admin area shows:

| | |
| --- | --- |
| **Licence & contract** | Who it is issued to and its term |
| **Plan limits** | What your agreement covers |
| **Current usage** | Users and workspaces in use |
| **Version** | The Orangescrum release you are running |

That version number is the first thing support will ask for.

## How limits work

> **The application does not enforce a project cap**
>
> Self-hosted Orangescrum does not limit projects in the software. If your
> install was sold with a per-seat or per-project licence, that limit is
> **contractual** rather than technical — the product will not stop you
> exceeding it.

That cuts both ways: nothing breaks if you go over, and nothing warns you
either. Check **Current usage** against your agreement periodically rather than
assuming the software is policing it.

## During installation

The installer asks for your **licence email**, validates it with Orangescrum, and
stores the key with the instance.

> **Validation needs outbound internet access**
>
> On a restricted or air-gapped network, allow the call before you start — or
> arrange an offline activation with support ahead of the install window.

## Add-ons

Optional modules are enabled per licence:

- **Wiki**: 
- **Document Management** 
- **Risk Management** 
- **Test Case Manager** 
- **Scaled Agile (SAFe)** 
- **Advanced Dashboard** 
- **Public API & webhooks** 
- **Versions & Releases**  Some need infrastructure as well as a licence — the Advanced Dashboard runs Superset and its own database, which is why the deployment has more than one service. See [Architecture](https://helpdesk.orangescrum.com/guide/self-hosted/get-started/architecture). ## Versions and releases Check your version before reporting a problem or planning an upgrade — behaviour and available modules differ between releases. Release notes accompany each package.  Applying a new release safely.

## The Public API differs from Cloud

> **Do not follow the Cloud API reference for a self-hosted install**
>
> The self-hosted **Public API** add-on is a different surface from the Orangescrum
> Cloud Developer API documented in the [API section](https://helpdesk.orangescrum.com/guide/api/introduction).
> Self-hosted exposes conventional REST — `GET`, `POST`, `PATCH`, `DELETE` under
> `/api/v1/{resource}` — plus a GraphQL endpoint and webhooks, authenticated with
> an `X-API-Key` header. Cloud's partner API is all `POST`, with HMAC-signed and
> encrypted payloads.
> Your instance ships an interactive reference at **`/developer`** — Swagger UI
> and GraphiQL against your own data. That is authoritative for your version.

An Owner or Admin enables the add-on and generates keys under
**Public API → Keys**. The secret is shown once at creation.

## Renewals and changes

- [Sales & licensing](mailto:sales@orangescrum.com): Renewals, seat changes, add-ons and custom sizing.

- [Technical support](mailto:support@orangescrum.com): Activation problems and deployment help.