definednet/dnclient repository overview

⁠dnclient - Official Docker Image

⁠Quick Reference

• Maintained by:
  Defined Networking⁠
• Where to get help:
  Defined Networking support⁠
• Supported architectures:
  amd64, arm64

⁠What is dnclient?

dnclient is the client software for Defined Networking Managed Nebula⁠.

Managed Nebula provides fast, secure overlay networking with unlimited scalability.

⁠How to use this image

This image allows you to run dnclient inside of a Docker container to provide DN Managed Nebula connectivity to the Linux host.

To run the image, use the following command:

docker run \
    --name dnclient \
    --network host \
    --cap-add NET_ADMIN \
    --volume defined:/etc/defined \
    --env DN_ENROLLMENT_CODE="insert code here" \
    --rm \
    definednet/dnclient

A few notes:

• --volume defined:/etc/defined will persist the config to a named volume across runs, so the host only needs to be enrolled once.
• --env DN_ENROLLMENT_CODE="insert code here" is necessary only for the first run. Get an enrollment code from the Managed Nebula Admin Panel⁠.
• The NET_ADMIN capability is necessary to create the tun adapter on the host (this is unnecessary if the tun device is disabled on the host.)

⁠Using docker-compose

Alternatively, you can save the following as docker-compose.yml and run it using docker compose up -d.

version: '2'
services:
  dnclient:
    image: definednet/dnclient
    network_mode: host
    cap_add:
      - NET_ADMIN
    volumes:
      - defined:/etc/defined
    environment:
      - DN_ENROLLMENT_CODE=insert code here
    restart: unless-stopped
volumes:
  defined: