Cleanup
This commit is contained in:
39
README.md
39
README.md
@@ -1,41 +1,8 @@
|
||||
# vppn: Virtual Pretty Private Network
|
||||
|
||||
## Roadmap
|
||||
## TODO
|
||||
|
||||
* Use probe and relayed-probe packets vs ping/pong.
|
||||
* Rename Mediator -> Relay
|
||||
* Use default port 456
|
||||
* Remove signing key from hub
|
||||
* Peer: UDP hole-punching
|
||||
* Peer: local peer discovery - part of RoutingProcessor
|
||||
* Peer: update hub w/ latest port on startup
|
||||
|
||||
## Learnings
|
||||
|
||||
* Encryption / decryption is 20x faster than signing/opening.
|
||||
* Allowing out-of order packets is massively important for throughput with TCP
|
||||
|
||||
## Principles
|
||||
|
||||
* Creates an IPv4/24 network with a maximum of 254 peers. (1-254)
|
||||
* Simple setup: via setup link from the hub.
|
||||
* Each peer has full network state replicated from the hub.
|
||||
|
||||
## Routing
|
||||
|
||||
* Routing is different for public vs non-public peers
|
||||
* Public: routes are initialized via incoming ping requests
|
||||
* NonPub: routes are initialized via incoming ping responses
|
||||
|
||||
A non-public peer needs to maintain connections with every public peer.
|
||||
|
||||
* Sending:
|
||||
* Public: send to address
|
||||
* Non-public: send to a mediator
|
||||
|
||||
* Pings:
|
||||
* Servers don't need to ping
|
||||
* Clients need to ping all public and local peers to keep connections open
|
||||
* Add `-force-init` argument to `node` main?
|
||||
|
||||
## Hub Server Configuration
|
||||
|
||||
@@ -106,7 +73,7 @@ AmbientCapabilities=CAP_NET_BIND_SERVICE CAP_NET_ADMIN
|
||||
Type=simple
|
||||
User=user
|
||||
WorkingDirectory=/home/user/
|
||||
ExecStart=/home/user/vppn -name vppn
|
||||
ExecStart=/home/user/vppn -name vppn -hub-address https://my.hub -api-key 1234567890
|
||||
Restart=always
|
||||
RestartSec=8
|
||||
TimeoutStopSec=24
|
||||
|
||||
Reference in New Issue
Block a user