Configuration

The RingLink Configuration File makes managing your network seamless by automating device registration, authentication, and network connections. Whether you’re deploying IoT devices, managing servers, or scaling remote networks, a well-structured configuration file ensures everything runs smoothly—without manual intervention.

Why Use a Configuration File? The configuration file simplifies device management by:

• Automating Device Registration: Use a Config Key to authenticate devices without interactive logins.
• Auto-Connecting Networks: Define networks your devices should automatically connect to.
• Minimizing Manual Work: Predefine settings to avoid repetitive tasks during deployment.

💡 Quick Tip: If you’re managing servers or IoT devices, a configuration file saves time by automating routine tasks.

Example Configuration File (config.toml)

Here’s a basic example of how your configuration file might look:

[server]
user_id = 1
token = "rl-config-key-ct8nlp2gnv1s738s79e0-...." # get it from dashboard "config-keys"
 
# if network_list is empty, ringlink-daemon will not auto connect to any network
network_list = ["23abb3d5"] #

Field Descriptions

• server (Table): The server table contains the configuration settings that RingLink uses to connect to a network.
  • user_id (Integer): The unique identifier for the user. This ID is typically used to create a local data directory to separate login sessions for different users.
  • token (String): The Config Key used for device authentication. It allows the device to connect to the network without requiring manual login.
  • network_list (Array): A list of network IDs that the device should automatically connect to. If not set or left empty, the device will not connect to any network by default.

How to Use the Configuration File (Linux)

To set up your device with a custom configuration file on Linux, follow these steps:

Option 1: Use the Default Configuration Path

1. Place the Configuration File Save your configuration file in the default location: /etc/ringlink/config.toml
2. Restart the RingLink service to apply the changes

systemctl restart ringlink 

Option 2: Specify a Custom Configuration File Path

You can also manually specify a custom configuration file path if needed. To do this:

1. Stop the currently running RingLink service

systemctl stop ringlink  # Stop the currently running RingLink service

2. Start RingLink with a Custom Configuration File Path

ringlink-daemon --config /path/to/config.toml # Start RingLink with a custom configuration file