Skip to main content

License Configuration

Overview​

The Appcircle server comes with a default license to let you explore Appcircle if you have installed it with Helm to a Kubernetes cluster.

If you have purchased a license from Appcircle, you can follow this documentation to apply your license.

Retrieving the Initial Organization ID​

The initial organization ID is printed alongside the Helm output during installation. If you miss the initial output or need to retrieve the organization ID later, use the following command:

info

appcircle-server is used as the release name in the following command as a sample release name. Make sure to replace it with your actual release name if it's different.

kubectl get secret appcircle-server-auth-keycloak \
  -n appcircle \
  -o jsonpath="{.data.initialOrganizationId}" | base64 --decode && echo

Creating a Secret for License Authentication​

Create a secret that contains the cred.json file you received from Appcircle to authenticate the Appcircle license.

  1. Save the cred.json file.

  2. Create/update the secret named ${releaseName}-auth-license with the credentialJson key:

kubectl create secret generic appcircle-server-auth-license \
  -n appcircle \
  --from-literal=credentialJson="$(cat cred.json | base64 -w0)" \
  --save-config --dry-run=client -o yaml | kubectl apply -f -
tip

Creating a secret for the license should be done once. Other license updates do not require repeating this step.

Updating the License​

If your organization’s Appcircle server license has been updated and you need to apply the new license, you can upgrade the Appcircle server deployment using Helm:

helm upgrade appcircle-server appcircle/appcircle \
  -n appcircle  \
  -f values.yaml

Need help?​

Get help from Appcircle's support team, or see how others are using Appcircle by joining our Slack Channel.

join.slack.com
No description available
join.slack.com
Preview of join.slack.com