Skip to content

License

Administrators can manage licenses by accessing License Management from the the top menu Configure > License.

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

license page

Server Information

In this section, you will find information about the server, e.g. Server hostname and Server CPU cores.

Send this information when requesting a license key.

In below example:

  • server hostname is pc-429.slashdb.lab and
  • server cpu cores is 1

server information

Current License Details

This section provides information about the currently installed license:

  • 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 connected databases
  • maximum number of CPU cores supported by the license
  • maximum number of identity providers that use JWT
  • maximum number of identity providers that use SAML
  • contact information

license information

Uploading New License

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

To update the license from the browser, follow the instructions on the License Management page

upload new license

First, click on button Attach License File and locate the license file on your computer. The new license will be validated. If the license file is invalid, an error message will show in red.

invalid hostname in license

If the license is valid, no message will be displayed. Click the Upload button.

valid license

The license file will be uploaded to the SlashDB server, the page will refresh and the new license information will appear in the section Current License Details

To upload using API, execute the following HTTP request

curl 'https://slashdb_host/license' \
  -i \
  -H 'apikey: 1234' \
  -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 defines the SlashDB version that the license applies to:
  • == exact version number e.g. == 1.4.2 license is valid only for server version 1.4.2
  • >= greater or equal than e.g. >= 1.3.0 license is valid for server version greater or equal than 1.3.0
  • <= less or equal than e.g. <= 1.5.0 license is valid for server version less or equal than 1.5.0
  • > greater than e.g. > 1.4.0 license is valid for server version greater than 1.4.0
  • < less than e.g. < 1.5.0 license is valid for server version less than 1.5.0
  • license-type can be:
  • Developer License for development purposes only or
  • 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, mysql, mariadb, postgresql, sqlite, sqlcipher, databricks, snowflake. 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 and 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 number of enabled identity providers that use the OpenId Connect protocol.
  • sso-saml is the 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

Database servers licensed

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 highlighted in green, and disabled ones are in red. For example, if the current license doesn't support Oracle, it will be highlighted in red. Users will not be able to use Oracle as the back-end data source.

Uploading a New License that supports Oracle would change its color to green.