License & plans

Hosted service: nothing to apply

The DataSquares hosted service (app.datasquares.ai) runs in hosted mode. There is no license file to apply, no evaluation period and no read-only mode: what a workspace is entitled to comes from its plan, managed under Admin → Billing → Plans, where the product plan and usage cards described at the end of this page also live. The Deployment license tab is not shown on the hosted service. Everything below applies to private-server deployments only — an option that is currently switched off for new installs.

DataSquares uses offline cryptographic licensing for private-server deployments. License files are verified on-premise or in private clouds using public-key cryptography embedded directly into the binary — eliminating phone-home requirements, external telemetry, or network calls.

Licensing is managed under Admin → Deployment license (/admin/license) and is restricted to workspace administrators.

Deployment modes

The API reads one environment variable, DEPLOYMENT_MODE, to decide which posture an instance runs:

Mode	Where	What it means
saas (default)	The hosted service	The license engine is inert. Entitlements come from plan grants and billing. PUT /api/license answers 409 LICENSE_NOT_APPLICABLE, the migration upgrade-block never fires, and the Deployment license tab is hidden.
selfhost	A private-server install	Everything on this page: pasted license → LICENSE_FILE → 30-day evaluation, the state ladder, read-only mode after an evaluation ends, and the upgrade-block on expired enterprise licenses.

Any other value refuses to boot, so a typo cannot silently disarm licensing on a private server. The self-host installer writes DEPLOYMENT_MODE=selfhost into .env.api; the hosted service leaves it at the default.

Applying a license

In Admin → License & Plans:

1. Open your license.json file and copy its full JSON content.
2. Paste the JSON text into the Apply a license input area.
3. Click Verify & apply.

The system cryptographically verifies the file against built-in trusted signer keys before storing it. If the signature or structure is invalid, an explicit error message is displayed (e.g. “Signature does not verify against any trusted signer key”).

Upon successful validation:

• Entitlements update instantly without restarting the application server.
• Degraded status banners clear immediately.
• The action is logged to the Audit Log.

Alternative provisioning methods

• Container Environment Variable: Mount the license file to the container and set LICENSE_FILE=/path/to/license.json.
• Automated REST API: Call PUT /api/license with { "file": "<json_string>" } using an administrative API key.

License status & metrics

The status card reports real-time licensing telemetry:

Property	Details
Licensee	Organization name registered in the license certificate.
Edition	enterprise (cryptographically signed) or eval (built-in evaluation).
Role	production, staging, or dr (staging and disaster recovery environments do not consume core quotas).
Licensed Cores	Number of CPU cores authorized under the enterprise agreement.
Measured Cores	Physical/virtual CPU allocation measured via cgroup-v2 / OS host hardware metrics.
Expiration Date	License expiration timestamp.
Maintenance End	End date of the active software maintenance and upgrade window.

License lifecycle states

Status Badge	State Code	Description & Impact
Licensed	ok	Active and fully compliant.
Evaluation	eval	30-day built-in trial period with days remaining.
Expiring soon	expiring_soon	Under 30 days until expiration. Normal operation, no UI banners.
Over core limit	over_cores	Host core count exceeds licensed allocation. Informational banner; never causes abrupt outages.
Grace period	grace	Expired within the last 30 days. Full operation continues with notification banner.
Expired	expired	Expired over 30 days ago. Running system continues operating; database migrations/upgrades are paused.
Evaluation ended	eval_expired	30-day trial concluded. System enters fail-safe read-only mode.

Zero-brick guarantee

Expired enterprise licenses never stop query execution or lock out users. Active dashboards and reports continue serving readers. Upgrade migrations are held until renewal, but existing workloads remain uninterrupted.

Read-only mode (Evaluation expiration)

When an unmanaged evaluation expires (eval_expired), the instance enters a protected read-only state:

• Read Operations & Viewing: All dashboards, paginated reports, model schemas, and charts remain accessible.
• Query Execution: SQL editor queries, data previewing, and metric queries execute normally.
• Exporting: PDF, Excel, PowerPoint, CSV, and image exports function without restriction — your data is never locked.
• Authentication: User logins, SSO redirection, MFA authentication, and password management remain active.
• License Application: The license activation form remains accessible to restore editing capabilities immediately.

Write operations (creating/editing dashboards, models, sources, or users) are safely paused with a descriptive 403 notification until a license is applied.

Product entitlements & usage cards

The Product Plan Cards — under Admin → Billing → Plans on the hosted service, and under the Deployment license tab on a private server — display real-time usage meters across licensed modules:

• BI Platform: Workspace seats, active dashboards, and monthly viewer allocations.
• Pipelines: Active pipeline DAGs, execution worker slots, and data volume processed.
• Warehouse: Managed dataset storage, query cache capacity, and sync frequencies.
• White Label: Custom branding, domain masking, and embed isolation entitlements.

Related

• Users, roles & invites — administrator access controls.
• Workspace settings & operations — tenant configuration and audit logs.
• Compute & workers — worker fleet provisioning and hardware sizing.