Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/components/NavigationDocs.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,7 @@ export const docsNavigation = [
{ title: 'Activity Events Postgres Store', href: '/selfhosted/activity-postgres-store'},
{ title: 'Supported IdPs', href: '/selfhosted/identity-providers' },
{ title: 'Management geolocation', href: '/selfhosted/geo-support' },
{ title: 'AmneziaWG support', href: '/selfhosted/amneziawg' },
{ title: 'Troubleshooting', href: '/selfhosted/troubleshooting' },
],

Expand Down
34 changes: 34 additions & 0 deletions src/pages/selfhosted/amneziawg.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import {Note} from "@/components/mdx";

# AmneziaWG support

Netbird uses amneziaWG protocol implementation under the hood. It's backward-compatible with basic wireguard so it's up to you to enable it or not.

## Management settings

To setup amneziaWG for you instance set these environment variables in docker-compose.yml:
```yaml
- NETBIRD_AMNEZIA_JC=
- NETBIRD_AMNEZIA_JMIN=
- NETBIRD_AMNEZIA_JMAX=
- NETBIRD_AMNEZIA_S1=
- NETBIRD_AMNEZIA_S2=
- NETBIRD_AMNEZIA_H1=
- NETBIRD_AMNEZIA_H2=
- NETBIRD_AMNEZIA_H3=
- NETBIRD_AMNEZIA_H4=
- NETBIRD_AMNEZIA_I1=
- NETBIRD_AMNEZIA_I2=
- NETBIRD_AMNEZIA_I3=
- NETBIRD_AMNEZIA_I4=
- NETBIRD_AMNEZIA_I5=
```

You can read further about settings in [AmneziaVPN documentation](https://docs.amnezia.org/documentation/amnezia-wg)

If you leave these settings empty basic wireguard protocol will be used

## Kernel implementation

On unix-based systems Netbird uses Kernel implementation of wireguard protocol if possible. With AmneziaWG settings enabled NetBird will choose basic golang implementation unless you install [amneziawg kernel module](https://github.com/amnezia-vpn/amneziawg-linux-kernel-module)