Licence and install tokens

A licence token is the token an Athenode Pro server exchanges for its licence key, the signed key that lets the server run. Athenode Pro is the Athenode server a team runs itself, with accounts, project roles and a licence. An install token is the token that installs and updates the @athenode/athenode-pro package. Both belong to an organisation, and you create them on the organisation's page in Athenode's web app, in the License and Install token sections.

	Licence token	Install token
What it is for	Activating a Pro server and renewing its licence key	Installing and updating Athenode Pro
Where you use it	On each Pro server, with athenode-pro license activate	In the .npmrc of the machine that installs Pro
How many	As many as you need, each with its own name	One per organisation
Shown in full	Once, when you create it	Once, when you create or rotate it
When you revoke it	Servers using it can no longer renew their key	Installing and updating Pro with it stops working

You need to be a billing administrator of the organisation. Creating a licence token, downloading the licence key and creating the install token also need a subscription that is active or past due, as billing for Athenode Pro describes. Without one, the License section says "No license key can be issued: this organisation has no active subscription." Revoking a token works at any time.

Create a licence token

Create one licence token for each Pro server, so that you can stop one server from renewing without touching the others.

1. On the organisation's page, in License, select Create license token.
2. In the Create a license token dialog, enter a Name of up to 100 characters that tells you where the token is used, such as "Production server".
3. Select Create.
4. The License token created dialog shows the token. Select Copy and keep the token somewhere safe, because it is shown only once.
5. Select Done.

The token appears under License tokens with its name and "Created on" with the date. After a server first uses it, the row says "last used on" and the date of the server's latest renewal; until then it says "never used". To put the token to work, activate the server with it, as the Pro licence describes.

A server renews its key with the token on its own. Each key lists the tier, seats, modules and features of the organisation's subscription at the time it is issued, so a change of the tier reaches the server at its next renewal, or at once with Check now on the server's License page.

If you lose a token, revoke it and create a new one. Athenode cannot show a token again.

Revoke a licence token

Revoke a token when a server is retired, or when the token may have been exposed.

1. On the organisation's page, in License, find the token under License tokens.
2. Select Revoke next to it.
3. Read the Revoke the license token? dialog, which says "Servers using" followed by the token's name and "can no longer renew their license key.", and select Revoke.

The token disappears from the list. Every server that uses it keeps its current key and runs until that key expires. To keep such a server running, create a new token and activate the server with it before the key expires.

Download the licence key

A Pro server without internet access cannot renew its key, so you download the key and import it on the server by hand.

1. On the organisation's page, in License, check the facts above the button: Tier, Seats, Modules, Included features, Not included, Support and Paid until.
2. Select Download license key.

Your browser saves the file athenode-pro-license.key. It holds the same key a server would receive through a licence token: the organisation's seats and modules, valid until the end of the paid period plus 14 days. Import it on the server with athenode-pro license import --file athenode-pro-license.key, as the page on the Pro licence describes.

A downloaded key does not renew itself. After each new billing period, download the key again and import it before the old key expires.

Create the install token

You need the install token to install Athenode Pro, and again on each update.

1. On the organisation's page, in Install token, select Create install token.
2. The Install token created dialog shows three boxes, each with a Copy button: Token, .npmrc and Install command. Copy all three now, because the token is shown only once.
3. Select Done.

The .npmrc box holds the line that gives npm the token. Add it to the ~/.npmrc file of the user who installs Pro on the server. The Install command installs @athenode/athenode-pro with that token. Use the lines as the dialog shows them, and do not add a line to ~/.npmrc that points the whole @athenode scope elsewhere, because the other @athenode packages, such as the Athenode CLI, come from the public npm registry. Install Athenode Pro covers the rest of the installation.

After Done, the Install token section shows the date the token was created. The token can only read the package registry that Athenode Pro is installed from. Without a subscription, selecting Create install token shows "This organisation needs an active subscription for an install token." and creates nothing.

Rotate the install token

Rotate the install token when it may have been exposed, or when someone who had it should no longer install Pro.

1. On the organisation's page, in Install token, select Rotate install token.
2. Copy the new values from the Install token created dialog, as in create the install token, and select Done.

Rotating creates a new token and revokes the old one, without a confirmation. Replace the old line in the ~/.npmrc of every machine that installs or updates Pro. Servers that are already installed keep running.

Revoke the install token

1. On the organisation's page, in Install token, select Revoke.
2. Read the Revoke the install token? dialog and select Revoke.

Installing or updating Athenode Pro with the token stops working. Installed servers keep running, and their licence keys keep renewing through their licence tokens. The section says "No install token yet.", and Create install token makes a new one.

What ends with the subscription

When the organisation's subscription ends, Athenode does this:

• It revokes the install token, so Pro can no longer be installed or updated with it.
• It issues no more licence keys. The licence tokens stay in the list, and a server that tries to renew with one is refused and stops renewing. Download license key is no longer offered, and creating a licence token is refused.
• Each Pro server keeps the key it holds and runs until that key expires, 14 days after the end of the last paid period. The page on the Pro licence describes what the server and its members see then.

A subscription whose last payment failed is past due. Its servers keep renewing and its tokens keep working, but each new key expires 14 days after the end of the last paid period, so the payment has to be made before then. When an organisation whose subscription ended subscribes again, create a new install token, and activate each server again with a licence token so that it renews again.

Deleting the organisation ends both kinds of token for good, as deleting an organisation describes.