pyrox.dev
1# Netbird server {#module-services-netbird-server}
2
3NetBird is a VPN built on top of WireGuard® making it easy to create secure private networks for your organization or home.
4
5## Quickstart {#module-services-netbird-server-quickstart}
6
7To fully setup Netbird as a self-hosted server, we need both a Coturn server and an identity provider, the list of supported SSOs and their setup are available [on Netbird's documentation](https://docs.netbird.io/selfhosted/selfhosted-guide#step-3-configure-identity-provider-idp).
8
9There are quite a few settings that need to be passed to Netbird for it to function, and a minimal config looks like :
10
11```nix
12services.netbird.server = {
13 enable = true;
14
15 domain = "netbird.example.selfhosted";
16
17 enableNginx = true;
18
19 coturn = {
20 enable = true;
21
22 passwordFile = "/path/to/a/secret/password";
23 };
24
25 management = {
26 oidcConfigEndpoint = "https://sso.example.selfhosted/oauth2/openid/netbird/.well-known/openid-configuration";
27
28 settings = {
29 TURNConfig = {
30 Turns = [
31 {
32 Proto = "udp";
33 URI = "turn:netbird.example.selfhosted:3478";
34 Username = "netbird";
35 Password._secret = "/path/to/a/secret/password";
36 }
37 ];
38 };
39 };
40 };
41};
42```