extern/EtherGuard-VPN
1
0
Fork 0
mirror of https://github.com/KusakabeShi/EtherGuard-VPN.git synced 2024-11-21 23:03:08 +01:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
KusakabeSi 2022-02-10 16:01:39 +00:00
parent 9fce61bf11
commit 3cca8f6be9
7 changed files with 21 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
example_config/p2p_mode/README.md
View File

@ -12,8 +12,10 @@ All edges runs [Floyd-Warshall Algorithm](https://en.wikipedia.org/wiki/Floyd–
First, edit the `gensp2p.yaml` First, edit the `gensp2p.yaml`
```yaml ```yaml
Config output dir: /tmp/eg_gen_static # Profile output location Config output dir: /tmp/eg_gen_static # Profile output location
ConfigTemplate for edge node: "" # Profile Template Enable generated config overwrite: false # Allow overwrite while output the config
Add NodeID to the interface name: false # Add NodeID to the interface name in generated edge config
ConfigTemplate for edge node: "" # Profile Template
Network name: "EgNet" Network name: "EgNet"
Edge Node: Edge Node:
MacAddress prefix: "" # Leave blank to generate randomly MacAddress prefix: "" # Leave blank to generate randomly

6
example_config/p2p_mode/README_zh.md
View File

@ -11,8 +11,10 @@ EdgeNodes會嘗試互相連線，並且通報其他EdgeNoses連線成功與否
首先，按照需求修改`gensp2p.yaml` 首先，按照需求修改`gensp2p.yaml`
```yaml ```yaml
Config output dir: /tmp/eg_gen_p2p # 設定檔輸出位置 Config output dir: /tmp/eg_gen_p2p # 設定檔輸出位置
ConfigTemplate for edge node: "" # 設定檔Template Enable generated config overwrite: false # 檔輸設定檔允許overwrite
Add NodeID to the interface name: false # 生成的config的interface name是否包含NodeID
ConfigTemplate for edge node: "" # 設定檔Template
Network name: "EgNet" Network name: "EgNet"
Edge Node: Edge Node:
MacAddress prefix: "" # 留空隨機產生 MacAddress prefix: "" # 留空隨機產生

6
example_config/static_mode/README.md
View File

@ -14,8 +14,10 @@ Please maintains the predefined topology, otherwise if the relay node offline, p
First, edit the `genstatic.yaml` First, edit the `genstatic.yaml`
```yaml ```yaml
Config output dir: /tmp/eg_gen_static # Profile output location Config output dir: /tmp/eg_gen_static # Profile output location
ConfigTemplate for edge node: "" # Profile Template Enable generated config overwrite: false # Allow overwrite while output the config
Add NodeID to the interface name: false # Add NodeID to the interface name in generated edge config
ConfigTemplate for edge node: "" # Profile Template
Network name: "EgNet" Network name: "EgNet"
Edge Node: Edge Node:
MacAddress prefix: "" # Leave blank to generate randomly MacAddress prefix: "" # Leave blank to generate randomly

6
example_config/static_mode/README_zh.md
View File

@ -14,8 +14,10 @@
首先，按照需求修改`genstatic.yaml` 首先，按照需求修改`genstatic.yaml`
```yaml ```yaml
Config output dir: /tmp/eg_gen_static # 設定檔輸出位置 Config output dir: /tmp/eg_gen_static # 設定檔輸出位置
ConfigTemplate for edge node: "" # 設定檔Template Enable generated config overwrite: false # 檔輸設定檔允許overwrite
Add NodeID to the interface name: false # 生成的config的interface name是否包含NodeID
ConfigTemplate for edge node: "" # 設定檔Template
Network name: "EgNet" Network name: "EgNet"
Edge Node: Edge Node:
MacAddress prefix: "" # 留空隨機產生 MacAddress prefix: "" # 留空隨機產生

2
example_config/super_mode/README.md
View File

@ -13,6 +13,8 @@ Edit the file `gensuper.yaml` based on your requirement first.
```yaml ```yaml
Config output dir: /tmp/eg_gen Config output dir: /tmp/eg_gen
Enable generated config overwrite: false # Allow overwrite while output the config
Add NodeID to the interface name: false # Add NodeID to the interface name in generated edge config
ConfigTemplate for super node: "" ConfigTemplate for super node: ""
ConfigTemplate for edge node: "" ConfigTemplate for edge node: ""
Network name: eg_net Network name: eg_net

2
example_config/super_mode/README_zh.md
View File

@ -14,6 +14,8 @@ EdgeNode首先和SuperNode建立連線，藉由SuperNode交換其他EdgeNode的
```yaml ```yaml
Config output dir: /tmp/eg_gen Config output dir: /tmp/eg_gen
Enable generated config overwrite: false # 檔輸設定檔允許overwrite
Add NodeID to the interface name: false # 生成的config的interface name是否包含NodeID
ConfigTemplate for super node: "" ConfigTemplate for super node: ""
ConfigTemplate for edge node: "" ConfigTemplate for edge node: ""
Network name: eg_net Network name: eg_net

2
version.go
View File

@ -1,3 +1,3 @@
package main package main
var Version = "v0.3.5-f1" var Version = "v0.3.5-f2"