diff options
author | Trumeet <17158086+Trumeet@users.noreply.github.com> | 2021-01-07 19:45:29 -0800 |
---|---|---|
committer | Trumeet <17158086+Trumeet@users.noreply.github.com> | 2021-01-07 19:45:29 -0800 |
commit | a5ed3da568f7542daa5e49ca0c1505f8c27d658c (patch) | |
tree | 80282452da704245e8a9a509f21b9f3d7a515ecb /README.md | |
download | dn42peering-a5ed3da568f7542daa5e49ca0c1505f8c27d658c.tar dn42peering-a5ed3da568f7542daa5e49ca0c1505f8c27d658c.tar.gz dn42peering-a5ed3da568f7542daa5e49ca0c1505f8c27d658c.tar.bz2 dn42peering-a5ed3da568f7542daa5e49ca0c1505f8c27d658c.zip |
First Commit
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..df20f10 --- /dev/null +++ b/README.md @@ -0,0 +1,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.
\ No newline at end of file |