5
0
mirror of https://github.com/cwinfo/yggdrasil-network.github.io.git synced 2024-11-14 04:30:31 +00:00
yggdrasil-network.github.io/faq.md

109 lines
6.9 KiB
Markdown
Raw Normal View History

2018-07-23 16:39:34 +00:00
---
sitemap: true
---
2018-06-18 19:24:35 +00:00
# FAQ
2018-06-18 19:35:02 +00:00
### Is Yggdrasil safe?
2018-06-18 19:24:35 +00:00
2018-06-18 19:27:55 +00:00
All traffic sent across the Yggdrasil network is encrypted end-to-end. Assuming that our crypto is solid, it cannot be decrypted or read by any intermediate nodes, and can only be decrypted by the recipient for which it was intended. However, please note that Yggdrasil has not been officially externally audited.
2018-06-18 19:24:35 +00:00
2018-06-18 19:35:02 +00:00
### Is Yggdrasil stable?
2018-06-18 19:24:35 +00:00
2018-06-18 19:27:55 +00:00
Our official stance is that it is still alpha software. Expect things to not be wholly smooth, and expect to have to upgrade often to the latest builds. That said, there is a small community of users who have not experienced any stability problems so far. Yggdrasil very rarely crashes.
2018-06-18 19:24:35 +00:00
2018-07-01 10:56:02 +00:00
### Is Yggdrasil anonymous?
2018-07-23 16:39:34 +00:00
It is not a goal of the Yggdrasil project to provide anonymity. Your direct peers may be able to determine your location if, for example, you are peering over the Internet.
2018-07-01 10:56:02 +00:00
2018-06-18 19:35:02 +00:00
### Does Yggdrasil work on my platform?
2018-06-18 19:27:55 +00:00
Quite likely! Take a look at the [Platforms](platforms.md) page - you'll find platform-specific notes there.
2018-06-18 19:24:35 +00:00
2018-06-18 19:35:02 +00:00
### Does Yggdrasil require IPv6?
2018-06-18 19:24:35 +00:00
Your system must be IPv6-capable, which just about all modern operating systems are.
While Yggdrasil does transport only IPv6 traffic internally, you do not need an IPv6 internet connection to peer with other Yggdrasil users. You can peer with other Yggdrasil nodes over either IPv4 or IPv6.
2018-06-18 19:35:02 +00:00
### Will Yggdrasil conflict with my network routing?
2018-06-18 19:24:35 +00:00
Yggdrasil uses the `0200::/7` range, which is a range deprecated by the IETF. It has been deprecated since 2004, pending changes to an RFC which simply never materialised 14 years later. It was decided to use this range instead of `fc00::/7` (which is more typically allocated to private networks) in order to prevent conflicts with existing ULA ranges.
As long as you are not using this deprecated address range on your network, you will not experience any routing conflicts.
2018-06-18 19:19:31 +00:00
2018-06-18 19:35:02 +00:00
### I've just installed Yggdrasil and I can't ping anyone. What have I missed?
2018-06-18 19:19:31 +00:00
Yggdrasil requires that you configure either a static peer to another Yggdrasil node, or that you discover another Yggdrasil node *on the same subnet* using multicast discovery (which is enabled by default). If you have not added or discovered any peers, you will not be able to reach beyond your own node.
You can check if you have any peers by running `yggdrasilctl getPeers` - peer on port 0 is your own node, ports 1 and above are your active peers.
Stuck for peers? Try adding a [public peer](https://github.com/yggdrasil-network/public-peers).
2018-06-18 19:35:02 +00:00
### I've installed the Yggdrasil Debian package and now I can't find the logs.
2018-06-18 19:19:31 +00:00
The Debian package installs the Yggdrasil service into systemd, therefore you can query systemd for the logs:
- `systemctl status yggdrasil`
- `journalctl -u yggdrasil`
2018-06-18 19:35:02 +00:00
### I've modified the configuration file but nothing has changed.
2018-06-18 19:19:31 +00:00
Yggdrasil only loads the configuration at startup. Restart the Yggdrasil process or service to load the new configuration.
2018-06-18 19:39:52 +00:00
### I'm running Yggdrasil on a machine that is directly reachable from the Internet. Does this mean anyone can peer with me?
2018-06-18 19:19:31 +00:00
2018-06-18 19:39:52 +00:00
Without any further configuration, yes.
2018-06-18 19:19:31 +00:00
2018-06-18 19:39:52 +00:00
However, you can either limit incoming connections to your host using a firewall by limiting or denying connections to the port specified in your `Listen` configuration option. This is useful if you want to limit peerings from certain IP ranges or on certain interfaces.
Alternatively, you can limit who can peer with you by modifying the `AllowedEncryptionPublicKeys` option in your Yggdrasil configuration. When this list is empty, any remote node is allowed to peer with you.
To restrict incoming peerings to certain nodes, you should first ask the operators of those nodes for their `EncryptionPublicKey` and then add those public keys into your own `AllowedEncryptionPublicKeys` list. From that point forward, only nodes with those public keys will be allowed to peer with you.
### I am running Yggdrasil from behind a NAT. Will this affect my connectivity?
To accept incoming peerings, you will probably need to configure port forwarding on your router/gateway. Yggdrasil listens on the port number specified in the `Listen` setting, so forward this port to the machine that runs Yggdrasil.
2018-07-01 10:56:02 +00:00
To use outbound peerings, that is, static peers that have been configured in your `Peers` setting, you will likely not need to change anything.
### Why does my Yggdrasil adapter have an unusually high MTU?
Yggdrasil peerings are typically stream-based and therefore don't suffer from fragmentation issues when pushing large amounts of data. By using the largest possible MTU supported by a platform, we can send much more data in each write, and the TCP connection will take care of the rest. This also helps somewhat in the reduction of TCP-over-TCP amplification, as there are less control messages to be amplified.
This also uses less CPU, as we can send more data for every system call on the TUN/TAP adapter or network socket. System calls often result in context switches by the operating system and are expensive operations, therefore by using an MTU of up to 65535, we can save as many as 42 context switches for each packet - a substantial performance improvement!
2018-06-18 19:19:31 +00:00
2018-06-18 19:35:02 +00:00
### I've changed my `AdminListen` port and now `yggdrasilctl` doesn't work.
2018-06-18 19:19:31 +00:00
2018-06-18 19:32:57 +00:00
`yggdrasilctl` will assume that your admin port is on `localhost:9001`. If you have changed it, simply pass your configured endpoint through to `yggdrasilctl`, i.e.
2018-06-18 19:19:31 +00:00
```
yggdrasilctl -endpoint=127.0.0.1:12345
```
2018-06-18 19:35:02 +00:00
### I want to run an Yggdrasil router to provide connectivity for other people, but I don't want them to be able to reach my own machine.
2018-06-18 19:19:31 +00:00
2018-06-18 19:32:57 +00:00
You can set the `IfName` configuration setting to `"none"`. This will load Yggdrasil, but will not create a TUN/TAP adapter, meaning that your host will not be exposed to the Yggdrasil network. This does of course mean that you won't be able to send any traffic from that node to Yggdrasil either!
2018-06-18 19:19:31 +00:00
2018-06-18 19:35:02 +00:00
### I want to allow outgoing connections from my machine but prevent unwanted incoming connections.
2018-06-18 19:19:31 +00:00
Generally this requires you to use a firewall. The steps for this will vary from platform to platform.
2018-06-18 19:35:02 +00:00
#### Linux (with `ip6tables`)
2018-06-18 19:19:31 +00:00
Assuming your TUN/TAP adapter is `tun0`:
```
ip6tables -A INPUT -i tun0 -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT
ip6tables -A INPUT -i tun0 -m conntrack --ctstate INVALID -j DROP
ip6tables -A INPUT -i tun0 -j DROP
```
2018-06-18 19:35:02 +00:00
#### Windows (with Windows Firewall)
2018-06-18 19:19:31 +00:00
Windows, by default, will classify the TAP adapter as a "Public Network". Configure Windows Firewall to prevent incoming connections on Public networks.
2018-06-18 19:35:02 +00:00
#### macOS (with built-in firewall)
2018-06-18 19:19:31 +00:00
macOS has an application firewall, therefore any firewall policies applied on other interfaces will also apply to the Yggdrasil interface.
2018-08-03 15:38:56 +00:00
### Is there any benefit to being the "root node" of the network?
No. At worst, the root node may be used in worst-case-scenario paths between
other nodes in the absence of being able to determine better routes, but this
is not advantageous.