diff --git a/self-host/advanced/config-file.mdx b/self-host/advanced/config-file.mdx index 0014cfe..4c15a0e 100644 --- a/self-host/advanced/config-file.mdx +++ b/self-host/advanced/config-file.mdx @@ -24,6 +24,10 @@ Minimal Pangolin configuration: gerbil: start_port: 51820 base_endpoint: "pangolin.example.com" # REPLACE WITH YOUR DOMAIN + # Optional network settings (defaults shown): + # subnet_group: "100.89.137.0/20" + # block_size: 24 + # site_block_size: 30 app: dashboard_url: "https://pangolin.example.com" # REPLACE WITH YOUR DOMAIN @@ -44,6 +48,12 @@ server: allowed_headers: ["X-CSRF-Token", "Content-Type"] credentials: false +# Optional organization network settings (defaults shown): +# orgs: +# block_size: 24 +# subnet_group: "100.90.128.0/20" +# utility_subnet_group: "100.96.128.0/20" + flags: require_email_verification: false disable_signup_without_invite: true @@ -505,19 +515,31 @@ This section contains the complete reference for all configuration options in `c IP address CIDR range for Gerbil exit node subnets. - **Example**: `10.0.0.0/8` + **Default**: `100.89.137.0/20` + + + The default uses the CGNAT range to avoid conflicts with typical private networks. + Block size for Gerbil exit node CIDR ranges. - **Example**: `24` + **Default**: `24` + + + A /24 block provides 256 IP addresses for the Gerbil network. + Block size for site CIDR ranges connected to Gerbil. - **Example**: `26` + **Default**: `30` + + + A /30 block provides 4 IP addresses per site. Consider using /29 (8 IPs) or /28 (16 IPs) for sites with heavy WireGuard usage. + @@ -531,24 +553,32 @@ This section contains the complete reference for all configuration options in `c Block size for organization CIDR ranges. - **Example**: `24` - **Default**: `24` - Determines the subnet size allocated to each organization for network isolation. + A /24 block provides 256 IP addresses per organization. Determines the subnet size allocated to each organization for network isolation. IP address CIDR range for organization subnets. - **Example**: `100.90.128.0/24` + **Default**: `100.90.128.0/20` - **Default**: `100.90.128.0/24` + **Example**: `100.90.128.0/20` - Base subnet from which organization-specific subnets are allocated. + Base subnet from which organization-specific subnets are allocated. Uses CGNAT range by default. + + + + + IP address CIDR range for utility subnets used by organizations. + + **Default**: `100.96.128.0/20` + + + Separate subnet range for utility network functions within organizations.