1
0
Fork 0
mirror of https://github.com/NeoCloud/NeoNetwork synced 2024-12-26 01:49:23 +08:00

document: route-dir.en_US: tidy up

This commit is contained in:
Neo_Chen 2020-04-23 22:56:26 +08:00
parent 7a3253e24b
commit dbbe38a471

View file

@ -1,17 +1,17 @@
IP Registration Directory Format Specification IP Registration Directory Format Specification
======================= ==============================================
According to the common usage of this VPN network, the IP allocation can be According to the common usage of this VPN network, the IP allocation can be
classified into the following rules, with its format normalized, as the classified into the following rules, with its format normalized, as the
file name of the routing distribution definition file: file name of the routing distribution definition file:
1. Point-to-Point /30 Tunnel `10.127.0.x/30` where x is divisible by 4 1. Point-to-Point /30 Tunnel: `10.127.0.x/30` where x is divisible by 4
2. Contiguous Subnet `10.127.x.y/z` (where z must be greater than 16 2. Contiguous Subnet: `10.127.x.y/z` (where z must be greater than 16
3. Peer-to-Peer `PP,10.127.x.x~10.127.x.x` IP on both sides is /32 3. Peer-to-Peer: `PP,10.127.x.x~10.127.x.x` IP on both sides is /32
4. Loopback Address `10.127.255.x/32` 4. Loopback Address: `10.127.255.x/32`
Definition Format Definition Format
======== =================
The content of the file can be divided into the following fields. The content of the file can be divided into the following fields.
To simplify processing, Shell Script variable definition syntax To simplify processing, Shell Script variable definition syntax
@ -19,26 +19,26 @@ will be used as the syntax of the definition file. In addition, variables must
be defined in the same order as the following: be defined in the same order as the following:
TYPE= TYPE=
PROTO= only for peer-to-peer /30 tunnels and peer-to-peer /32 peers PROTO= (only for peer-to-peer /30 tunnels and peer-to-peer /32 peers)
SUBNET= or PEER=<UPSTREAM IP>~<DOWNSTREAM IP> SUBNET= or PEER=<UPSTREAM IP>~<DOWNSTREAM IP>
UPSTREAM= only for peer-to-peer /30 tunnels and peer-to-peer /32 peers UPSTREAM= (only for peer-to-peer /30 tunnels and peer-to-peer /32 peers)
DOWNSTREAM= only for peer-to-peer /30 tunnels and peer-to-peer /32 peers DOWNSTREAM= (only for peer-to-peer /30 tunnels and peer-to-peer /32 peers)
Detailed Information of Each Variable Detailed Information of Each Variable
============== =====================================
1. TYPE: IP Usage Type 1. TYPE: IP Usage Type
Available options are: TUN30, SUBNET, PP, LO corresponding to the IP address Available options are: TUN30, SUBNET, PP, LO (corresponding to the IP address
allocation type in the first section respectively allocation type in the first section respectively)
2. PROTO: VPN Protocol Used 2. PROTO: VPN Protocol Used
Available options are: Tinc, WireGuard, GRE, IPsec/L2TP, IPsec/GRE, OpenVPN Available options are: Tinc, WireGuard, GRE, IPsec/L2TP, IPsec/GRE, OpenVPN
3. SUBNET: Subnet Used 3. SUBNET: Subnet Used
Format Use CIDR Notation Format: Use CIDR Notation
4. PEER: Peer-to-Peer Address 4. PEER: Peer-to-Peer Address
Format <UPSTREAM IP>~<DOWNSTREAM IP> Format: <UPSTREAM IP>~<DOWNSTREAM IP>
5. UPSTREAM: Upstream Node Name 5. UPSTREAM: Upstream Node Name
6. DOWNSTREAM: Downstream Node Name 6. DOWNSTREAM: Downstream Node Name