Skip to content

License

Important

Click here to see all the options for licensing. Developer licenses are always free.

Administrators can manage the SlashDB license by clicking the License link in the main menu.

This page allows the admin user to view information about the server and the currently installed license. The admin user can also install a new license key (i.e. upgrade).

Info

Only the admin user has access to view or update the license.

license page

Server Information

This section has information about the server such as the Server hostname and Server CPU cores.

Important

Send this information when requesting a license key.

server information

  • Server hostname is pc-429.slashdb.lab
  • Server CPU cores is 1

Current License Details

This section provides information about the currently installed license:

license information

  • license type
  • version of SlashDB covered by the license
  • expiration date
  • unique product key
  • maximum number of users that can be defined in SlashDB

  • maximum number of concurrently connected databases
  • maximum number of CPU cores supported by the license
  • maximum number of JWT identity providers
  • maximum number of SAML identity providers
  • contact information

Uploading A New License

A license can be uploaded from the browser or using the API.

Browser

upload new license

Click on the Attach License File button and locate the license file on your computer.

After selecting the file, click the Upload button.

Success

The license file will be uploaded to the SlashDB server, and validated. Once validate, the page will refresh and the new license information will appear the Current License Details.

Important

invalid hostname in license

If the license file is invalid, an error message will show in the top right corner of the screen.

API

To upload a license using the API, execute the following HTTP request:

curl 'https://slashdb_host/license' \
  -i \
  -H 'apikey: [yourkey]' \
  -H 'Content-Type: text/plain' \
  --data-binary @/path/to/license.key

HTTP/1.1 200 OK

License File

The license is a text file that contains the folllowing properties:

  • product is name of the product, e.g. SlashDB
  • version specifies the SlashDB version that the license applies to:
  • == exact version number e.g. == 2.0.0 license is valid only for product version 2.0.0
  • >= greater or equal than e.g. >= 1.8.0 license is valid for product version greater or equal than 1.8.0
  • <= less or equal than e.g. <= 1.7.0 license is valid for product version less or equal than 1.7.0
  • > greater than e.g. > 1.5.0 license is valid for product version greater than 1.6.0
  • < less than e.g. < 1.4.0 license is valid for product version less than 1.5.0
  • license-type can be either:
  • Developer License for development purposes only
  • Production License for production purposes
  • expiration is a date in format YYYY-MM-DD that specifies when the license expires, e.g. 2021-12-31. An empty value means the license never expires.
  • registered is for internal purposes
  • dbtypes is a comma-separated list of database types for which the license is valid. Users will only be able to connect to the listed databases. Valid options are: mssql, db2, oracle, mysql, mariadb, postgresql, sqlite, sqlcipher, databricks, snowflake, trino. When uploading a license that does not support certain database types, the unsupported databases must be disconnected before uploading the license.
  • max-databases is the maximum number of connected databases that the license supports. The number of connected databases must be less than or equal to max-databases in the license.
  • max-users is the maximum number of users aside from admin that can be created in SlashDB e.g. 5 allows for 1 admin user plus 5 other users. The number of users must be less than or equal to max-users + 1 in new license.
  • max-cpu-cores is the maximum number of CPU cores in the server that the license supports. An empty value means that the license is valid for any number of cores.
  • hostname-fqdn is the hostname of the server. An empty value means that the license is valid for any hostname.
  • sso-jwt is the maximum number of enabled identity providers that use the OpenId Connect protocol.
  • sso-saml is the maximum number of enabled identity providers that use the SAML protocol.
  • organization is the name of the organization that the license was issued to.
  • organization-dept is the optional name of the department in the organization that the license was issued to.
  • billing-contact-name, billing-contact-email and billing-contact-phone are optional contact information fields for a person responsible for product purchasing.
  • technical-contact-name, technical-contact-email and technical-contact-phone are optional contact information fields for a system administrator responsible for maintenance of the server and SlashDB.
  • key is a unique verification key that validates the license.

License File Example

[License]
product: SlashDB
version: < 1.5.0
license-type: Production License
expiration:
registered: True
dbtypes: mssql, mysql, sqlite, postgresql, db2, sqlcipher, mariadb
max-databases: 5
max-users: 20
max-cpu-cores:
hostname-fqdn:
sso-jwt: 3
sso-saml: 0
organization: VTE
organization-dept:
billing-contact-name: John Tutorial
billing-contact-email: john.tutorial@slashdb.com
billing-contact-phone:
technical-contact-name:
technical-contact-email:
technical-contact-phone:
key: 6d6.....dada

Licensed Database Servers

The lower section on the license page shows the types of database servers that the current license allows users to connect to.

licensed database types

Databases that are enabled are displayed in full color, and disabled ones are displayed in greyscale.