README

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.

Nebula incorporates a number of existing concepts like encryption, security groups, certificates,
and tunneling.
What makes Nebula different to existing offerings is that it brings all of these ideas together,
resulting in a sum that is greater than its individual parts.

Further documentation can be found here.

You can read more about Nebula here.

You can also join the NebulaOSS Slack group here.

 Supported Platforms

 Desktop and Server

Check the releases page for downloads or see the Distribution Packages section.

- Linux - 64 and 32 bit, arm, and others
- Windows
- MacOS
- Freebsd

 Distribution Packages

- Arch Linux
    sh
    sudo pacman -S nebula
    

- Fedora Linux
    sh
    sudo dnf install nebula
    

- Debian Linux
    sh
    sudo apt install nebula
    

- Alpine Linux
    sh
    sudo apk add nebula
    

- macOS Homebrew
    sh
    brew install nebula
    

- Docker
    sh
    docker pull nebulaoss/nebula
    

 Mobile (source code)

- iOS
- Android

 Technical Overview

Nebula is a mutually authenticated peer-to-peer software-defined network based on the Noise Protocol Framework.
Nebula uses certificates to assert a node's IP address, name, and membership within user-defined groups.
Nebula's user-defined groups allow for provider agnostic traffic filtering between nodes.
Discovery nodes (aka lighthouses) allow individual peers to find each other and optionally use UDP hole punching to establish connections from behind most firewalls or NATs.
Users can move data between nodes in any number of cloud service providers, datacenters, and endpoints, without needing to maintain a particular addressing scheme.

Nebula uses Elliptic-curve Diffie-Hellman (ECDH) key exchange and AES-256-GCM in its default configuration.

Nebula was created to provide a mechanism for groups of hosts to communicate securely, even across the internet, while enabling expressive firewall definitions similar in style to cloud security groups.

 Getting started (quickly)

Don't want to manage your own PKI and lighthouses? Managed Nebula from Defined Networking handles all of this for you.

To set up a Nebula network, you'll need:

 1. The Nebula binaries or Distribution Packages for your specific platform. Specifically you'll need nebula-cert and the specific nebula binary for each platform you use.

 2. (Optional, but you really should..) At least one discovery node with a routable IP address, which we call a lighthouse.

Nebula lighthouses allow nodes to find each other, anywhere in the world. A lighthouse is the only node in a Nebula network whose IP should not change. Running a lighthouse requir