-
Notifications
You must be signed in to change notification settings - Fork 55
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add IPv6 related documentation #165
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
|
||
# Configure IPv6 support for your peers | ||
|
||
In addition to IPv4, Netbird also supports both establishment of connections over IPv6 as well as assignment of IPv6 addresses | ||
to peers within the network. | ||
|
||
<Note> | ||
Assignment of IPv6 addresses is available for NetBird [TODO] or later. | ||
</Note> | ||
|
||
<Note> | ||
Assignment of IPv6 addresses is currently only supported on Linux peers using the kernel Wireguard module and nftables firewall backend. | ||
</Note> | ||
|
||
## Configure IPv6 for a specific peer | ||
|
||
To set the IPv6 setting of a specific peer, navigate to the peers tab and adjust the "IPv6 Support" setting using the dropdown menu. | ||
|
||
<p> | ||
<img src="/docs-static/img/how-to-guides/peer-settings-ipv6.png" alt="high-level-dia" width="700" className="imagewrapper"/> | ||
</p> | ||
|
||
There are three options for the peer's IPv6 status: | ||
- **Force enabled:** Enable IPv6 for the peer regardless of group membership or configured routes. | ||
- **Automatic (default):** Enable IPv6 for the peer if it is either... | ||
- ...a member of a group with the IPv6 setting enabled, or... | ||
- ...assigned as the routing peer of an IPv6 route. | ||
- **Force disabled:** Disable IPv6 for the peer regardless of group memberships. | ||
|
||
<Note> | ||
Force disabling IPv6 will disable all IPv6 routes configured for this peer.<br /> | ||
After re-enabling IPv6, the routes will have to be re-enabled manually. | ||
</Note> | ||
|
||
The peer's IPv6 address can be seen both in the peers tab as well as the peer settings. | ||
|
||
## Configure IPv6 for an entire group | ||
Instead of enabling IPv6 manually for each peer, you can instead enable IPv6 for an entire group at once. | ||
|
||
To enable IPv6 for an entire group, open the group settings and enable the IPv6 toggle in the table. | ||
|
||
<p> | ||
<img src="/docs-static/img/how-to-guides/account-settings-groups-ipv6.png" alt="high-level-dia" width="700" className="imagewrapper"/> | ||
</p> | ||
|
||
All peers that are a member of the group, support IPv6 and have their peer-specific IPv6 setting set to _Automatic_ will be given an IPv6 address. | ||
|
||
## What's next? | ||
|
||
Here are a few links that might be handy as you venture further into NetBird: | ||
|
||
- [Add new peers to your network](/how-to/add-machines-to-your-network) | ||
- [Creating routes to private networks](/how-to/routing-traffic-to-private-networks) | ||
- [Configure DNS for your network](/how-to/manage-dns-in-your-network) | ||
|
||
<p float="center" > | ||
<Button name="button" className="button-5" onClick={() => window.open("https://netbird.io/pricing")}>Try NetBird</Button> | ||
</p> | ||
|
||
- Make sure to [star us on GitHub](https://github.com/netbirdio/netbird) | ||
- Follow us [on Twitter](https://twitter.com/netbird) | ||
- Join our [Slack Channel](https://join.slack.com/t/netbirdio/shared_invite/zt-vrahf41g-ik1v7fV8du6t0RwxSrJ96A) | ||
- NetBird [latest release](https://github.com/netbirdio/netbird/releases) on GitHub |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Before merging, this [TODO] must be replaced with the version of netbird that introduces the changes of netbirdio/netbird#1459.