Skip to main content

Registration

Your registration key determines how many nodes you can register and how long the license is valid. All analysis features are included in the license.

Registering​

Register once with the key you received from AVEQ, and with the server of your organization:

surfmeter-media --server <customer>-analytics register --registration-key <REGISTRATION_KEY>

Replace <customer> with your customer name. For AVEQ-hosted servers, <customer>-analytics expands to https://surfmeter-server.<customer>-analytics.aveq.info. The Clients > Create Client page of your Surfmeter Dashboard shows the command with your server and key filled in.

You can add a label and tags, which are shown for this node in the Surfmeter Dashboard. Separate tags by comma.

surfmeter-media --server <customer>-analytics register --registration-key <REGISTRATION_KEY> \
--label "Encoding lab, workstation 2" --tags lab,encoding

You can also set the key with SURFMETER_DEFAULT_REGISTRATION_KEY and the server with SURFMETER_DEFAULT_SERVER. The default server is AVEQ's demo server.

For an on-premises server, give the full URL:

surfmeter-media --server https://surfmeter.example.com register --registration-key <REGISTRATION_KEY>

Checking the license​

surfmeter-media license shows the registration and the license state, without contacting the server:

surfmeter-media license

Add --json for machine-readable output, for example for monitoring scripts.

License validity

We check the license every 24 hours. If the server cannot be reached, it keeps working for 7 days after the last successful check. If the server reports that the license has expired or the node was disabled, you need to register again with a valid key.

Profile file​

The registration is stored in a profile file, by default ~/.config/surfmeter/media-toolkit.json.

To use a different location, for example for a service account, pass --profile <path> or set SURFMETER_MEDIA_PROFILE.

Unregistering​

To return the license to your key, for example before you decommission a machine:

surfmeter-media unregister

This frees the slot on the server and deletes the local profile.

Using CI or short-lived environments

In containers or CI jobs that start from a clean state for every run, a permanent registration would use a new slot each time. Use --ephemeral instead: it registers at the start of the run and returns the license at the end.

export SURFMETER_DEFAULT_REGISTRATION_KEY=<REGISTRATION_KEY>
surfmeter-media --server <customer>-analytics analyze --ephemeral -o results input.ts

Docker​

In Docker, the profile is stored at /config/media-toolkit.json. To keep the registration across container restarts, store the profile in a named volume:

docker volume create surfmeter-media-config

docker run --rm --user "$(id -u):$(id -g)" \
-v surfmeter-media-config:/config \
europe-west3-docker.pkg.dev/aveq-storage/surfmeter/surfmeter-media:latest \
--server <customer>-analytics register --registration-key <REGISTRATION_KEY>

docker run --rm --user "$(id -u):$(id -g)" \
-v surfmeter-media-config:/config -v "$PWD:/data" \
europe-west3-docker.pkg.dev/aveq-storage/surfmeter/surfmeter-media:latest \
analyze -o results input.ts
Use the same user for all runs

Only the user who registered can read the profile. If you register with --user, pass the same --user to every later run that uses the volume, and leave it out everywhere if you registered without it.

For one-off runs, use an ephemeral registration without a volume:

docker run --rm --user "$(id -u):$(id -g)" -v "$PWD:/data" \
-e SURFMETER_DEFAULT_REGISTRATION_KEY=<REGISTRATION_KEY> \
europe-west3-docker.pkg.dev/aveq-storage/surfmeter/surfmeter-media:latest \
--server <customer>-analytics analyze --ephemeral -o results input.ts