From 5a4d753035907fee2c79dd9b6086602c3d6f4c24 Mon Sep 17 00:00:00 2001 From: Owen Date: Sun, 2 Nov 2025 14:52:54 -0800 Subject: [PATCH] Add missing config values --- self-host/advanced/config-file.mdx | 198 +++++++++++++++++++++++++++++ 1 file changed, 198 insertions(+) diff --git a/self-host/advanced/config-file.mdx b/self-host/advanced/config-file.mdx index 4c47916..c3ae2ed 100644 --- a/self-host/advanced/config-file.mdx +++ b/self-host/advanced/config-file.mdx @@ -247,6 +247,16 @@ This section contains the complete reference for all configuration options in `c Generate a strong, random secret. This is used for encrypting sensitive data and should be kept secure. + + + Path to the MaxMind GeoIP database file for geolocation features. + + **Example**: `./config/GeoLite2-Country.mmdb` + + + Used for IP geolocation functionality. Requires a MaxMind GeoLite2 or GeoIP2 database file. + + @@ -399,6 +409,14 @@ This section contains the complete reference for all configuration options in `c When enabled, uses file-based dynamic configuration instead of API-based updates. + + + Prefix used for transport-related configurations. References servers transport config in dynamic Traefik file. + + **Example**: `pp-transport-v` + + **Default**: `pp-transport-v` + @@ -450,6 +468,38 @@ This section contains the complete reference for all configuration options in `c +### Organization Settings + + + Organization network configuration settings. + + + + Block size for organization CIDR ranges. + + **Example**: `24` + + **Default**: `24` + + + 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/24` + + + Base subnet from which organization-specific subnets are allocated. + + + + + ### Rate Limiting @@ -473,6 +523,32 @@ This section contains the complete reference for all configuration options in `c + + + Rate limit settings specifically for authentication endpoints. + + + + Time window for authentication rate limiting in minutes. + + **Example**: `1` + + **Default**: `1` + + + + Maximum number of authentication requests allowed in the time window. + + **Example**: `10` + + **Default**: `500` + + + Consider setting this lower than global limits for security. + + + + @@ -585,6 +661,46 @@ This section contains the complete reference for all configuration options in `c **Default**: `false` + + + Whether to disable local site creation and management. + + **Default**: `false` + + + When enabled, users cannot create sites that connect to local networks. + + + + + Whether to disable basic WireGuard site functionality. + + **Default**: `false` + + + When enabled, only advanced WireGuard configurations are allowed. + + + + + Whether to disable domains managed through the configuration file. + + **Default**: `false` + + + When enabled, only domains created through the UI are allowed. + + + + + Whether to enable client functionality. + + **Default**: `true` + + + Controls access to client-related features and endpoints. + + @@ -603,6 +719,88 @@ This section contains the complete reference for all configuration options in `c See [PostgreSQL documentation](/self-host/advanced/database-options#postgresql) for setup instructions. + + + Read-only replica database configurations for load balancing. + + + + Connection string for the read replica database. + + **Example**: `postgresql://user:password@replica-host:port/database` + + + + + + Database connection pool settings. + + + + Maximum number of connections to the primary database. + + **Default**: `20` + + **Example**: `50` + + + + Maximum number of connections to replica databases. + + **Default**: `10` + + **Example**: `25` + + + + Time in milliseconds before idle connections are closed. + + **Default**: `30000` (30 seconds) + + **Example**: `60000` + + + + Time in milliseconds to wait for a database connection. + + **Default**: `5000` (5 seconds) + + **Example**: `10000` + + + + + + +### DNS Configuration + + + DNS settings for domain name resolution and CNAME extensions. + + + + List of nameservers used for DNS resolution. + + **Example**: `["ns1.example.com", "ns2.example.com"]` + + **Default**: `["ns1.pangolin.net", "ns2.pangolin.net", "ns3.pangolin.net"]` + + + These nameservers are used for DNS queries and domain resolution. + + + + + Domain extension used for CNAME record management. + + **Example**: `cname.example.com` + + **Default**: `cname.pangolin.net` + + + Used for creating CNAME records for dynamic domain routing. + +