Use the license command to import a license key.
License options
Usage: octopus.server license [<options>]
Where [<options>] is any of:
--instance=VALUE Name of the instance to use
--config=VALUE Configuration file to use
--licenseBase64=VALUE Base64 encoded version of the license key XML
--licenseFile=VALUE Path to the file containing the license key XML
in plain text
--skipLicenseCheck Skips the license check when setting the license
Or one of the common options:
--help Show detailed help for this command
Basic examples
This example supplies the license in a Base64 encoded string to use for the Octopus Server instance named OctopusServer:
octopus.server license --instance="OctopusServer" --licenseBase64="RXhhbXBsZVN0cmluZ1NpbXVsYXRpbmdMaWNlbnNlS2V5QXNCYXNlNjQ="
Please note: the value used in the --licenseBase64 here is not a valid license key for use with Octopus.
This example supplies the license in a file named octopus-server-licensekey.xml to use for the Octopus Server instance named OctopusServer:
octopus.server license --instance="OctopusServer" --licenseFile="C:\temp\octopus-server-licensekey.xml"
This example supplies the license in a file named octopus-server-licensekey.xml to use for the Octopus Server instance named OctopusServer, skipping the license check when setting it:
octopus.server license --instance="OctopusServer" --licenseFile="C:\temp\octopus-server-licensekey.xml" --skipLicenseCheck
Help us continuously improve
Please let us know if you have any feedback about this page.
Page updated on Sunday, January 1, 2023