Config Key
Supported Version: Linux v0.3.4+
The Config Key feature in RingLink allows you to register devices on your private network without needing interactive logins. This is particularly useful in scenarios where devices need to be registered in bulk, or when non-interactive, server-side environments require automated registration.
What is a Config Key?
A Config Key is a unique token that simplifies device authentication and registration on RingLink networks. It allows devices to be registered without manually logging in through the ringlink-cli login process, making it ideal for server environments and automated deployments.
RingLink provides two types of Config Keys:
| Config Key Type | Description |
|---|---|
| One-Time | Can be used register one device. |
| Reusable | Can be used multiple times to register multiple devices. |
💡 Tip: Use One-Time Keys for critical devices to enhance security.
How Does the Config Key Work?
When using the RingLink client for the first time, if the --config option specifies a configuration file containing Config key as token, RingLink will automatically use the Config Key to register the device.
Important Notes
- A Config Key is always tied to the tenant owner’s account. Devices authenticated with a Config Key will be registered under the owner’s control.
- Since non-interactive logins are typically used for server environments, devices registered with a Config Key will receive non-expiring tokens, ensuring long-term access without requiring re-authentication.
How to Generate a Config Key
- Log in to the RingLink Dashboard: Go to Dashboard and sign in to your account.
- Navigate to the Config Keys Section: In the left-hand menu, click Config Keys.
- Click the Add Button: Choose whether you want to create a One-Time or Reusable Config Key.
Note: A Config Key is only consumed when registering a previously unconnected device.
- Copy and Save the Key: Copy the key immediately after it is generated. RingLink does not store the key, and it will not be visible again after you close the window.
How to Use a Config Key
Use the Config Key in your configuration file to automate device registration and skip manual logins.
Want to learn how to set it up? Check out the RingLink Configuration Guide for step-by-step instructions.