Installing a License for Martini Server Runtime
After installing and deploying Martini Server Runtime, the next crucial step is installing your license. Martini Server Runtime requires a valid license to function, and you will be prompted to provide your license key upon initial startup if it hasn't been installed yet.
The installation process varies based on deployment method. Choose the appropriate installation method based on how Martini Server Runtime is deployed (Installer or Docker).
If Installed via Installer
If Martini Server Runtime was installed via the Installer, you’ll be prompted to install a license during the installation process:
- During installation, you will be prompted to log in to your Lonti account.
- Select the subscription for which you would like the license assigned.
- Once selected, Martini Runtime will automatically retrieve and install the license.
If Deployed via Docker
If you’re deploying Martini Server Runtime via Docker:
- Obtain License: Log in to console.lonti.com to generate a license key.
- Set License in Docker: Use the generated license key as an environment variable in Docker when starting Martini Runtime:
1
docker run -e MR_LICENSE=<your-license-key> toroio/martini-runtime
- Externalize License: Ensure the license is stored externally to persist across container restarts.
Methods for Installing a License
You can also install a license after deployment through either the Admin UI or the CLI Tool.
Via Martini Runtime Admin UI
Steps to Install via Admin UI
-
Access Martini Runtime Admin UI: Open your browser and navigate to
http://<martini-host>:8080
. Without a license installed, Martini will redirect you to the license installation page. -
Automatic License Installation:
- Choose "Automatic license installation" and click Continue.
- You will be redirected to the TORO Marketplace's register product key page where you need to log in.
- Select your organization and license type.
- Click "Generate License" which will redirect you back to the Martini Runtime Admin login page.
-
Manual License Installation:
- Choose "Manual license installation".
- Note the product key shown on your machine.
- Generate your license key against your Martini Server Runtime license in Lonti Cloud Console.
- Paste the generated license key in the provided text area.
- Click Save to complete the installation.
Via CLI Tool
CLI Commands for License Management
Command | Description |
---|---|
export-license |
Exports the current license to a file. |
import-license |
Imports a license from a specified file. |
install-license |
Installs a license using a provided key. |
license |
Displays the currently installed license. |
product-key |
Shows the product key. |
sync-license |
Synchronizes the installed license with the server. |
Steps to Install via CLI
-
Generate License Key: Obtain your license then the
product-key
command to retrieve your product key.1 2
> product-key XXXX-XXXX-XXXX-XXXX
-
Install the License: Use the
install-license
command with your license key as an argument.1 2
> install-license --license "<your license key here>" License installed.
For a detailed overview of the CLI Tool, please visit our documentation page.
CLI Tool usage
The CLI tool is intended for managing licenses on local machines. It cannot connect to remote instances for license management. For remote instances, use the Martini Runtime Admin interface or operate the CLI tool directly on the server.
Updating a License for Martini Server Runtime
The license update method depends on the deployment method (Installer or Docker).
If Installed via Installer
-
Via Admin UI:
- Open the Admin UI at
http://<martini-host>:8080
, navigate to License. - Choose Sync License or manually enter a new license key and click Save.
- Open the Admin UI at
-
Via CLI Tool:
- To install a new license key:
1 2
> install-license --license "<your-new-license-key>" License installed.
- To sync the license with the TORO Marketplace:
1
> sync-license
- To install a new license key:
Excessive License Syncing
Be cautious of syncing your license too frequently. License sync is limited to once every 10 minutes. Exceeding this limit will result in an error.
1 2 |
|
If Deployed via Docker
- Update License: Update the license file in the externalized path you configured for Docker.
- Restart Docker: Restart Martini Runtime to apply the new license.
Generating a License for Martini Server Runtime
Obtaining a license for Martini Server Runtime is a crucial step in setting up your server environment. This process ensures that your server runtime is compliant with the licensing terms and can access the full range of features offered by Martini. Follow these steps to generate and download your license.
Access License Management:
- Log in to your account at my.lonti.com.
- Navigate to the Martini page from the main menu.
Go to Server Runtime:
- In the License Management section, select Server Runtime.
Select Your Subscription:
- Choose the relevant subscription under which you wish to generate the license.
License Overview:
Under the License Overview tab, you'll find a summary of your license entitlements, including:
- The total number of vCPUs you are licensed for.
- Your current usage of vCPUs.
Issue a New License:
- Use the Issue License link to create a new license for your Martini Server Runtime subscription.
- Follow the prompts to specify the required details for your license.
Download the License:
- After issuing the license, use the Download License link to download the license file.
- This license file will be required during the installation process of Martini Server Runtime.
Important Notes
- License Compliance: Ensure that the license issued matches your operational needs and complies with the licensing terms.
- vCPU Allocation: Be mindful of the number of vCPUs allocated in your license, as this should align with your server setup.
- Backup License File: Store a backup of the license file in a secure location for future reference or in case of system recovery.
Upgrading from Free to Commercial License
To upgrade your license from the free edition to a commercial one:
- Purchase a New Subscription: Start by purchasing a new subscription.
- Access Previous Subscription: Navigate to your previous subscription.
- Initiate Upgrade: Click the options button on your previous license and select Upgrade to Commercial License.
- Select New Subscription: Choose your newly purchased subscription and click Proceed.
Your previous product key will be under your new subscription. Update your license using the steps mentioned above.