You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*[Viewing Enabled Features and Limits](#features_and_limits)
28
+
*[Upgrading or Increasing Limits](#upgrading_limits)
22
29
23
30
## Introduction
24
31
Organizations are Shuffle's way of organizing data, and can be thought of as tenants. Data from Apps, Workflows, Notifications, Files etc. are all related to an organization from which users gain access based on their access rights. This document is made to explain what the different options for organizations are.
@@ -43,25 +50,6 @@ This view outlines the basic details of your organizations, which any Admin can
43
50
* The **open source** version gives you an API-key field. This can be used in the cloud version.
Cloud synchronization is a FREE feature used to get more capabilities on-premises, that otherwise wouldn't be possible. These range from scalability to collaboration, support, public workflow generation, accessibility and more. The goal is to give access to features that otherwise are impossible to build in a location solution. See [Hybrid Features](#hybrid_features) for more info.
64
-
65
53
### App Runs Management for Suborg (Enterprise)
66
54
Starting from version 2.0.2, enterprise users can manage suborg app run limits from the parent organization. The maximum limit that can be assigned to a suborg is equal to the app run limit of the parent organization. For example, if the parent org has an app run limit of 300k, the maximum limit that can be assigned to each suborg is also 300k.
67
55
@@ -340,3 +328,140 @@ You can create notifications yourself with the Notification Creation API from Sh
340
328
**Disabling a Notification:**
341
329
You can ignore/disable a notification by clicking the "Disable" button next to any of them.
342
330
331
+
## Billing
332
+
333
+
### Onprem Licensing
334
+
Shuffle’s licensing system enables organizations to unlock advanced capabilities designed for production deployments and enterprise grade scalability.
335
+
336
+
While the open-source version of Shuffle includes all core workflow automation functionality, running Shuffle in production environments or at scale (including multi-tenant or multi-environment setups) requires a valid on-premise license.
337
+
338
+
Licensing ensures access to premium features such as high-performance scaling, multi-tenant management, multi-environment configurations, and full platform branding empowering organizations to customize, optimize, and securely manage their automation infrastructure.
339
+
340
+
### Cloud Synchronization
341
+
Cloud synchronization is a feature used to get more capabilities on-premises, that otherwise wouldn't be possible. These range from scalability to collaboration, support, public workflow generation, accessibility and more. The goal is to give access to features that otherwise are impossible to build in a location solution. See [Hybrid Features](#hybrid_features) for more info.
367
+
368
+
A valid **Shuffle license** is required to unlock advanced enterprise capabilities on your on-premise instance.
369
+
370
+
With a valid license, connecting your instance to the cloud allows you to access features such as **multi-tenant management**, **multi-environment setups**, **workflow executions**, and **branding customization**.
371
+
372
+
#### Default Limits
373
+
By default, Shuffle onprem instance includes the following limits:
374
+
375
+
-**Workflow Executions:** 10,000 per month
376
+
-**Sub-Organizations:** Up to 3
377
+
-**Environments:** 1
378
+
-**Branding** not Enabled
379
+
380
+
To run Shuffle **in production** or to **scale beyond default limits**, a valid **on-premise Shuffle license** is required.
381
+
Licensing ensures access to advanced scaling, customization, and management features designed for enterprise and high-availability deployments.
For air-gapped or offline environments where **Cloud Synchronization** cannot be used, Shuffle supports activating enterprise features through an **on-premise license key**.
388
+
389
+
The license key allows organizations to unlock capabilities for **scaling**, **multi-tenancy**, **multi-environment setups**, and **branding** enabling full production use of Shuffle on-premises.
390
+
391
+
#### Applying a License Key
392
+
393
+
To activate your license, set the `SHUFFLE_LICENSE` environment variable in your on-prem deployment:
394
+
395
+
```bash
396
+
export SHUFFLE_LICENSE=<your_license_key>
397
+
```
398
+
Once applied, Shuffle will automatically recognize and unlock the licensed capabilities no internet connection is required.
399
+
400
+
#### Features Unlocked by License
401
+
402
+
A valid **Shuffle license** unlocks a range of enterprise capabilities.
403
+
The availability of these features depends on the **type and level of your license**.
404
+
405
+
| Feature | Description |
406
+
|----------|-------------|
407
+
|**Workflow Scaling**| Increase monthly workflow execution limits to support larger workloads. |
408
+
|**Multi-Tenant Management**| Add and manage more sub-organizations within a single deployment. |
409
+
|**Multi-Environment Support**| Create and operate multiple isolated environments. |
410
+
|**Branding Customization**| Enable full white-label branding, including logo, colors, and support links. |
411
+
412
+
> **Note:** The exact features and limits available to your organization depend on your Shuffle license tier.
You can securely store your license key in the **Datastore** tab (`/admin?tab=datastore`) or save it in a text file and upload it via the **Files** tab (`/admin?tab=files`) in the Admin panel.
416
+
417
+
Alternatively, you may store the key outside of Shuffle (e.g., in a secure local or cloud storage) to ensure it can be recovered if the key is lost.
418
+
419
+
## Production Readiness (Onprem)
420
+
421
+
The **Production Readiness** section helps administrators verify whether their **Shuffle on-premise instance** is properly licensed, synchronized, and configured for stable production use.
422
+
423
+
Running Shuffle in production requires both a **valid on-prem license** and a **verified production configuration**, ensuring your deployment can support enterprise workloads with high availability, scalability, and reliability.
424
+
425
+
To **unlock default limits** ([see details here](https://shuffler.io/docs/organizations#default-limits)) for your on-prem instance, you must activate a valid license using either **[Cloud Synchronization](https://shuffler.io/docs/organizations#cloud-synchronization)** or a **[License Key](https://shuffler.io/docs/organizations#license-key)**.
426
+
427
+
Once your license is applied, navigate to the `/admin?admin_tab=billingstats` tab in the Admin panel and verify that:
428
+
429
+
-**Production Status** is set to **“On”**
430
+
- The following indicators show a **green checkmark**:
431
+
**License**, **Multi-Tenant**, **High Availability**, and **Robust Infrastructure**
Based on your license type, you can view detailed subscription information in the **Billing Stats** section of the Admin panel (`/admin?admin_tab=billingstats`), as shown below:
0 commit comments