cwinfo/yggdrasil-network.github.io
5
0
Fork 0
mirror of https://github.com/cwinfo/yggdrasil-network.github.io.git synced 2024-11-10 03:20:25 +00:00
Code Releases Activity

Update configuration.md

Browse Source
This commit is contained in:
Neil Alexander 2018-05-09 16:56:32 +01:00 committed by GitHub
parent 377593a649
commit 061823a36e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
configuration.md
View File

@ -85,12 +85,12 @@ Note that any field not specified in the configuration will use its default valu
- `IfName` - `IfName`
- The name of the `tun` or `tap` network interface to create or use. Applications send packets over this interface to use the network. - The name of the `tun` or `tap` network interface to create or use. Applications send packets over this interface to use the network.
- On most platforms, an empty string or the default `"auto"` will create a new interface automatically. - On most platforms, an empty string or the default `"auto"` will create a new interface automatically.
- You can also specify `none` as the interface name, in which case Yggdrasil will run as a router only without opening a network interface. This effectively allows Yggdrasil to carry traffic for other nodes without exposing the system to the network. - You can also specify `"none"` as the interface name, in which case Yggdrasil will run as a router only without opening a network interface. This effectively allows Yggdrasil to carry traffic for other nodes without exposing the system to the network.
- The behaviour of this option is different on different operating systems. Some quick notes: - The behaviour of this option is different on different operating systems. Some quick notes:
- On Linux, any suitable interface name can be specified. - On Linux, any suitable interface name can be specified.
- On FreeBSD, OpenBSD and NetBSD, a full path to the TAP interface should be specified, i.e. `/dev/tap0`. - On FreeBSD, OpenBSD and NetBSD, a full path to the TAP interface should be specified, i.e. `"/dev/tap0"`.
- On macOS, a utun device is automatically assigned by the operating system, therefore you cannot specify a name. - On macOS, a utun device is automatically assigned by the operating system, therefore you cannot specify a name.
- On Windows, a network adapter friendly name (like `Local Area Connection 2`) can be specified to choose a specific adapter. Use "Network Adapters" in Control Panel to see and/or rename adapters. - On Windows, a network adapter friendly name (like `"Local Area Connection 2"`) can be specified to choose a specific adapter. Use "Network Adapters" in Control Panel to see and/or rename adapters.
- `IfTAPMode` - `IfTAPMode`
- If true, then the interface will be a `tap` device (Layer 2) instead of a `tun` (Layer 3) device. - If true, then the interface will be a `tap` device (Layer 2) instead of a `tun` (Layer 3) device.
- Default value is platform specific, and some platforms support only `tun` or `tap` mode. - Default value is platform specific, and some platforms support only `tun` or `tap` mode.