# omniedge-supernode

Generated on 25 Mar 2025 from [the omniedge-supernode catalog page](https://marketplace.digitalocean.com/apps/omniedge-supernode)

OmniEdge Supernode is used to coordinates the communication between nodes within the virtual network, help your omniedge nodes connect peer-to-peer, and as a fallback to relay traffic between nodes in case NAT traversal fails and a direct connection can not be established.

## Software Included

| Package | Version | License |
|---|---|---|
| [docker-customize-supernode](https://github.com/omniedgeio/docker-customize-supernode) | v2.6-stable-omni | GPL-3.0 |

## Creating an App using the Control Panel

Click the **Deploy to DigitalOcean** button to create a Droplet based on this 1-Click App. If you aren’t logged in, this link will prompt you to log in with your DigitalOcean account.

[![Deploy to DO](https://www.deploytodo.com/do-btn-blue.svg)](https://cloud.digitalocean.com/droplets/new?image=omniedge-omniedgesupernod)

## Creating an App using the API

In addition to creating a Droplet from the omniedge-supernode 1-Click App using the control panel, you can also use the [DigitalOcean API](https://docs.digitalocean.com/reference/api). As an example, to create a 4GB omniedge-supernode Droplet in the SFO2 region, you can use the following `curl` command. You need to either save your [API access token](https://docs.digitalocean.com/reference/api/create-personal-access-token/index.html.md) to an environment variable or substitute it in the command below.

```shell
curl -X POST -H 'Content-Type: application/json' \
         -H 'Authorization: Bearer '$TOKEN'' -d \
        '{"name":"choose_a_name","region":"sfo2","size":"s-2vcpu-4gb","image":"omniedge-omniedgesupernod"}' \
        "https://api.digitalocean.com/v2/droplets"
```

## Getting Started After Deploying omniedge-supernode

1. Create a droplet
2. Choose an image from MarketPlace and find “omniedge-supernode”
3. Select the $4m droplet
4. Click “Create Droplet” and wait for the initial booting of your Droplet
5. Copy the IP of your Droplet
6. [Login in](https://omniedge.io) your OmniEdge account, and fill your server IP and port in the [dashboard](https://omniedge.io/dashboard/virtual-networks/)([https://omniedge.io/dashboard/virtual-networks/)](https://omniedge.io/dashboard/virtual-networks/%29).

![](https://omniedge.io/assets/docs/OmniEdge-CustomizeAuthServer.png)