Connector Metadata

Overview

Twingate supports adding custom metadata as key-value pairs to Connectors when deploying them. Any metadata you add will be displayed in the Connector detail view in the Admin console.

For many of the deployment methods we've provided in the Admin console, we preset the hostname metadata value with the local hostname of the device the Connector is deployed on. This helps with identifying where the Connector in question has been deployed later on.

Setting custom metadata

Setting custom metadata is done by setting an environment variable. The key is set to the string after the environment variable prefix TWINGATE_LABEL_, with any value up to 255 characters valid for the metadata value. An example is shown below:

# When the connector is deployed in the example below, the following metadata will be set:
# machine_name = server.autoco.internal

$ hostname
server.autoco.internal
$ TWINGATE_LABEL_MACHINE_NAME=`hostname`
$ export TWINGATE_LABEL_MACHINE_NAME

Did this page help you?