Skip to content

Commit 186073b

Browse files
authored
docs: Add LICENSE_MAX_USERS_OVERRIDE usage (#9905)
1 parent abc4d87 commit 186073b

2 files changed

Lines changed: 19 additions & 0 deletions

File tree

‎docs/source/guide/admin_usage.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ Here you can see the number of seats compared with the number of active users.
2121

2222
Each organization has a set amount of Label Studio seats in their license. To increase your seats, contact your HumanSignal account representative.
2323

24+
!!! note On-premise
25+
On-premise deployments can use fewer seats than their license allows by setting the `LICENSE_MAX_USERS_OVERRIDE` environment variable. It can only lower the licensed seat count, and the deployment does not start if you set it higher. Seats are counted across all organizations in the deployment. See [Available Helm values](helm_values#The-global-extraEnvironmentVars-usage).
26+
2427
### License info
2528

2629
This section includes general information about your Label Studio license, such as when it was issued and when it expires.

‎docs/source/guide/helm_values.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -324,4 +324,20 @@ global:
324324
!!! note
325325
If you are deploying to a production environment, you should set `SSRF_PROTECTION_ENABLED: true`. See [Secure Label Studio](security#Enable-SSRF-protection-for-production-environments).
326326

327+
<div class="enterprise-only">
328+
329+
### Lower the seat limit of your license
330+
331+
Set `LICENSE_MAX_USERS_OVERRIDE` to use fewer seats than your license allows, for example to keep a staging deployment within a smaller budget:
327332

333+
```yaml
334+
global:
335+
extraEnvironmentVars:
336+
LICENSE_MAX_USERS_OVERRIDE: 50
337+
```
338+
339+
By default this variable is not set and the seat count from your license applies. It can only *lower* that count: if you set it higher than your licensed seats, or below `1`, the deployment fails to start. The license itself is not modified, so removing the variable and restarting restores the licensed seat count.
340+
341+
Because on-premise seats are counted across all organizations in the deployment, the override applies to the whole deployment rather than to a single organization. It also lowers the number of free View-Only seats when your license does not set them explicitly. See [Usage & License](admin_usage#Seats-in-use).
342+
343+
</div>

0 commit comments

Comments
 (0)