License Key Management

The Ridgeback License

Ridgeback is a licensed, on-premise solution designed to keep all your network data securely on-site. Despite its local focus, Ridgeback periodically connects to a remote license server to authenticate your installation and validate product permissions. This ensures proper licensing while maintaining the highest standards of data security and privacy.

License Name and Key

Your Ridgeback license consists of two components:

1. License Name: An identifier unique to your organization.
2. License Key: A unique alphanumeric code provided when you purchase Ridgeback.

These credentials authenticate your installation and ensure access to Ridgeback's features. Keep your license name and key secure and do not share them with unauthorized individuals.

The License and the .env Configuration File

The .env file is a critical configuration file for Ridgeback. It stores environment variables, including your license details. During installation, the license name and key are automatically added to this file.

• Location: The .env file is typically located in the Ridgeback folder (e.g., C:\Program Files\Ridgeback\ on Windows).
• Content Example:

  LICENSE_NAME=YourOrganizationName
  LICENSE_KEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  

When Ridgeback starts, it reads the license information from the .env file to authenticate with the Ridgeback license server.

The Ridgeback License Server

The Ridgeback license server verifies the license details during installation and periodically while Ridgeback is running. This ensures compliance and validates active support agreements. The process is seamless when:

• The machine has an active internet connection.
• License details in the .env file are correct.

If the machine hosting Ridgeback does not have internet access, offline licensing may be available. Contact Ridgeback support for assistance.

Troubleshooting License Issues

Common Problems and Solutions

1. Invalid License Error:

   • Cause: Incorrect license name or key in the .env file.
   • Solution: Verify the details against your original license email. Correct any typos and restart Ridgeback.

2. License Not Found:

   • Cause: The .env file is missing or improperly configured.
   • Solution: Re-run the installation process or manually recreate the .env file with the correct license details.

3. Connectivity Issues:

   • Cause: The machine cannot connect to the Ridgeback license server.
   • Solution: Ensure the machine has internet access. For firewalled environments, allow outbound connections on the necessary ports.

4. Expired License:

   • Cause: The license subscription has ended.
   • Solution: Renew your license by contacting Ridgeback sales or through the Ridgeback website. Update the .env file with the new license details.

Best Practices

• Regularly back up the .env file and license information to a secure location.
• Notify Ridgeback support immediately if you suspect your license has been compromised.
• Keep your Ridgeback installation updated to ensure compatibility with the license server.

Proper license management ensures uninterrupted operation of Ridgeback and compliance with the licensing terms.