nebulaoss/nebula repository overview

⁠Nebula - Official Docker Image

⁠Quick Reference

• Maintained by:
  Defined Networking⁠ and Slack⁠
• Where to get help:
  Github⁠ or Slack⁠
• Supported architectures:
  amd64, arm64

⁠What is Nebula?

Nebula is a scalable overlay networking tool with a focus on performance, simplicity and security. It lets you seamlessly connect computers anywhere in the world. Nebula is portable, and runs on Linux, OSX, Windows, iOS, and Android. It can be used to connect a small number of computers, but is also able to connect tens of thousands of computers.

Further documentation can be found here.⁠

⁠How to use this image

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

To run the image, use the following command:

docker run \
    --name nebula \
    --network host \
    --cap-add NET_ADMIN \
    --volume ./config:/etc/nebula \
    --rm \
    nebulaoss/nebula

Notes:

• The NET_ADMIN capability is necessary to create the tun adapter on the host (this is unnecessary if the tun device is disabled in the Nebula config file.)
• --volume ./config:/config should point to a directory containing the Nebula config file (named config.yml) and any other necessary files (e.g. CA, certificate, private key, etc.)

⁠Using docker-compose

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

services:
  nebula:
    image: nebulaoss/nebula
    network_mode: host
    cap_add:
      - NET_ADMIN
    volumes:
      - ./config:/config
    restart: unless-stopped