Relatude Help

35.4 Connecting an installation

Use the Relatude Services page of the admin UI, in the server menu:

  1. Create a free license opens the portal. Sign in and pick or create a license, and its API key comes back to the installation by itself. If you already have a key, choose I have an API key and paste it; the page checks it with the license server before saving it.
  2. The page then shows the license and what it carries, and has a test for each service. The tests make real calls, so they are charged, except IP lookup, which is free.
  3. Cloud sign-in adds Sign in with Relatude Services to the admin UI's login page, for anyone with access to the license in the portal. The master login is not affected. Turning it off ends those sessions at once.

Remove, beside the API key, takes the installation out from under the license. It clears the keys and turns cloud sign-in off.

Anyone who has the API key can spend the license's credits. On a server, keep it out of relatude.db.json like other secrets (§12.2), and set it in configuration:

dotnet user-secrets set "RelatudeDB:ApiKey" "…"
# on a server: an environment variable, or an application setting on Azure App Service
RelatudeDB__ApiKey=…

A key set in configuration is locked on the page; change it where it is set. The settings involved are listed under Server level in §12.1.

Reporting in

With an API key, the installation reports in to the license server shortly after it starts, and then every ten minutes. A report holds the API key, the installation's key and name, the server and machine names, the build version and the number of nodes in the open databases. It holds no content, no queries and nothing about the people who use the database. Nothing acts on the answer, so a lapsed license or an unreachable license server never stops a database. To stop the reports, set "DisableHeartbeat": true in relatude.db.json; the setting is not on the settings pages.