Using RingLink with Docker

A brief overview of RingLink and instructions for running it with Docker.

Quick Start

To get started, run RingLink using the following command:

docker run -d \
--name ringlink \
--network host \
--cap-add=NET_ADMIN \
-v /dev/net/tun:/dev/net/tun \
-v /var/lib/ring-link:/var/lib/ring-link \
-e CONFIG_KEY=<your-config-key> \
-e USER_ID=<your-user-id> \
-e NETWORK_ID=<network-id> \
ringlink/ringlink:latest

Parameters Explanation

CONFIG_KEY: Configuration key (optional); can be generated in the RingLink dashboard under Config Keys.
USER_ID: User ID (optional); the ID of a user in your tenant (see Users).
NETWORK_ID: 8-bit hexadecimal ID of a network (see Networks) (optional).

Alternatively, you can log in without specifying the parameters (CONFIG_KEY, USER_ID, and NETWORK_ID) by running:

docker exec -it ringlink /app/ringlink-cli login

For further information, visit the Authenticate with Your RingLink Account.

Troubleshooting

View logs using: docker logs ringlink

❓ Container cannot join the network?
- Ensure the host kernel has TUN support enabled, and verify any relevant network policies.
❓ Permission denied on /dev/net/tun?
- Ensure Docker is run as root or with equivalent privileges.

Using RingLink with Docker

Quick Start

Troubleshooting

On this page