aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: df20f1081fa8e485918f2a45e6948f1fccfd20bb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# dn42peering

A dn42 auto-peering platform.

## Components

* **Central**: Installs on some machines. They will provide HTTP portal and store user data.
* **Agent**: Installs on target nodes. They will receive commands from the **central** and apply changes to the system.

Refer to project Wiki for more details.

## Overview

The central provides a HTTP portal, and connects to a MySQL database. It will perform most tasks, including user management and peering management.

The central establishes connections to agents when necessary. It will ask the agents to perform provisioning tasks. For example, setup BGP and VPN tunnels.

The whole project is written in Java, with the support of Vert.x framework. The communication between centrals and agents is done by gRPC.

## Get Started

See [Quick Start](docs/QuickStart.md) for more details.

## License

Proprietary Software with open source components.