Registration

Each instance of Automator needs to be registered with the Surfmeter server. The setup script and the Docker container can do this for you. In that case, you can skip to Checking the Registration.

Registering a Client

You need a registration key and the address of your Surfmeter server. You can create registration keys in the dashboard under Registration Keys, or ask AVEQ.

surfmeter auth register \
    --registrationKey <registrationKey> \
    --server https://surfmeter-server.example.com \
    --label Vienna-Office \
    --tags lab --tags vienna

The label and tags are optional, but we recommend setting a label.

Keep the client registration

The registration is stored in ~/.surfmeter. Deleting this directory makes the registration invalid.

Checking the Registration

surfmeter auth status          # Show the registration of this client
surfmeter auth status --verify # Also check it with the server

Labeling Clients

The label identifies a client in the dashboards, and is part of each measurement data point. Labels must be unique.

surfmeter auth label show
surfmeter auth label set Vienna-Office
surfmeter auth label clear

Changes in the label also apply to historical data.

Tagging Clients

Each client can have multiple tags, and each tag can be assigned to multiple clients. Tags can be used to filter the data, and they can select the configuration of a client.

Setting tags replaces the existing list

surfmeter auth tags set replaces all existing tags. Include every tag you want to keep.

surfmeter auth tags list
surfmeter auth tags set lab vienna
surfmeter auth tags clear

Unregistering Clients

Unregistering returns the client's license to the pool and removes its local identity. The client cannot run studies afterwards:

surfmeter auth unregister

Next, run a study, or manage the configuration.