Skip to main content

Configuration: License Options

License​

  • When using this configuration key in settings.json, embed the license key as a string, e.g.:
    "License": "{ paste your license key including curly brackets here }"
  • When using this configuration key as an environment variable, embed the JSON license key object.
  • If License is set, it overrides the License.Path configuration key.
  • Type: string
  • Default: null
  • Scope: Server-wide only

License.Path​

  • Save the license key to a license.json file.
  • Provide the path to this file in the 'License.Path' configuration key:
    Either as a full path to the license file, e.g.:
    "License.Path": "D:\\RavenDB\\Server\\license.json"
    Or as a relative path to the license file from the Server folder, e.g.:
    "License.Path": "License\\license.json"
    (where the 'License' folder is under the 'Server' folder)
  • Type: string
  • Default: license.json
  • Scope: Server-wide only

License.Eula.Accepted​

Indicates whether the EULA (End User License Agreement) has been accepted.

  • Type: bool
  • Default: false
  • Scope: Server-wide only

License.CanActivate​

EXPERT ONLY.
Indicates if license can be activated.

  • Type: bool
  • Default: true
  • Scope: Server-wide only

License.CanForceUpdate​

EXPERT ONLY.
Indicates if license can be updated from the License Server at api.ravendb.net.

  • Type: bool
  • Default: true
  • Scope: Server-wide only

License.CanRenewLicense / License.CanRenew​

EXPERT ONLY.
Indicates if license can be renewed from the License Server at api.ravendb.net.
Relevant only for Developer and Community licenses.

  • Type: bool
  • Default: true
  • Scope: Server-wide only

License.SkipLeasingErrorsLogging​

EXPERT ONLY.
Skip logging of lease license errors.

  • Type: bool
  • Default: false
  • Scope: Server-wide only

License.DisableAutoUpdate​

EXPERT ONLY.
Disable all license updates: from a string, from a path, and from the License Server at api.ravendb.net.

  • Type: bool
  • Default: false
  • Scope: Server-wide only

License.DisableAutoUpdateFromApi​

EXPERT ONLY.
Disable automatic updates of the license from the License Server at api.ravendb.net.
Can still update the license by either:

  • Setting the License configuration key
  • Setting the License.Path configuration key
  • Replacing the license.json file on disk
  • Type: bool
  • Default: false
  • Scope: Server-wide only

License.DisableLicenseSupportCheck​

EXPERT ONLY.
Disable checking the license support options from the License Server at api.ravendb.net.

  • Type: bool
  • Default: false
  • Scope: Server-wide only
In this article