diff options
| author | Trumeet <yuuta@yuuta.moe> | 2021-04-02 19:29:26 -0700 |
|---|---|---|
| committer | Trumeet <yuuta@yuuta.moe> | 2021-04-02 19:29:26 -0700 |
| commit | c056e7ffb3d0f4ecf62d9927c5761b034d740620 (patch) | |
| tree | 735ed3ee887b8aca3d16e232b22e006914674ad8 | |
| parent | 3e158541dfd0e62be094c5cc0f76dd3babca4ab6 (diff) | |
| download | dn42peering-c056e7ffb3d0f4ecf62d9927c5761b034d740620.tar dn42peering-c056e7ffb3d0f4ecf62d9927c5761b034d740620.tar.gz dn42peering-c056e7ffb3d0f4ecf62d9927c5761b034d740620.tar.bz2 dn42peering-c056e7ffb3d0f4ecf62d9927c5761b034d740620.zip | |
docs: copy README to docs/v1.12
| -rw-r--r-- | docs/README.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..df20f10 --- /dev/null +++ b/docs/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 |