--- title: "Private Configuration File" description: "Configure advanced Pangolin settings using the privateConfig.yml file for enterprise features" --- import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx"; The `privateConfig.yml` file provides advanced configuration options for enterprise deployments. This file is mounted at `config/privateConfig.yml` in your Docker container. The private configuration file is only used on enterprise deployments. If you're using Pangolin Community, refer to the [main configuration file documentation](/self-host/advanced/config-file) instead. The private config file is not required. ## Setting up your `privateConfig.yml` Here's a basic example with common settings: ```yaml title="private-config.yml" app: identity_provider_mode: "org" branding: app_name: "My Company Portal" hide_auth_layout_footer: false ``` ## Reference This section contains the complete reference for all configuration options in `private-config.yml`. ### Application Settings Regional and base domain configuration for multi-region deployments. Set the identity provider (IdP) mode for authentication. By default both global and org pages will show until set. See the [Identity Providers documentation](/manage/identity-providers/add-an-idp#identity-provider-types) for more details on how this affects authentication and user management. Possible values: - `global`: (default) Both global and organization-level IdP login pages are available. Users can authenticate using either global or organization-specific identity providers. - `org`: Only organization-level IdP login pages are available. Users must authenticate using identity providers defined at the organization ```yaml app: identity_provider_mode: "org" ``` The region identifier for this Pangolin instance. Used for multi-region deployments. ```yaml app: region: "us-east-1" ``` ### Server Configuration Advanced server configuration including encryption keys and API integrations. Path to the RSA private key used for encrypting sensitive data. Must be at least 8 characters long. THIS IS ONLY USED WITH pangolin_dns FEATURE FLAG ENABLED AND REQUIRES EXTERNAL COMPONENTS. ```yaml server: encryption_key_path: "./config/encryption.pem" ``` The `encryption_key_path` must point to a valid RSA key file. Generate one using: ```bash openssl genrsa -out encryption.pem 4096 ``` Keep this key secure and backed up - it encrypts sensitive data in your database. ### Redis Configuration Redis connection settings for caching, sessions, and rate limiting. Useful for clustering Pangolin nodes. Redis server hostname or IP address. ```yaml redis: host: "redis.example.com" ``` Redis server port (1-65535). ```yaml redis: port: 6379 ``` Redis authentication password. ```yaml redis: password: "your-secure-password" ``` Redis database number (0-15 typically). ```yaml redis: db: 0 ``` Array of read replica configurations for high-availability deployments. ```yaml redis: host: "redis-primary" port: 6379 replicas: - host: "redis-replica-1" port: 6379 password: "replica-password" db: 0 - host: "redis-replica-2" port: 6379 password: "replica-password" db: 0 ``` Replica server hostname. Replica server port. Replica authentication password. Database number on replica. ### Gerbil Tunnel Configuration Configuration for the Gerbil tunnel exit node integration. URL where the local Gerbil exit node can be reached by Pangolin. Useful when clustering multiple pangolin nodes. Overrides the value stored in the database. Useful when using Docker and address the local gerbil container using the host's address. ```yaml gerbil: local_exit_node_reachable_at: "http://gerbil:3004" ``` ### Feature Flags Feature toggles for advanced functionality. **DEPRECATED**! See `app.identity_provider_mode: "org"` instead. Restrict identity provider (IdP) authentication to organization-level only. ```yaml flags: use_org_only_idp: true ``` Enable automatic synchronization of ACME certificates for TLS termination on private resources. ```yaml flags: enable_acme_cert_sync: true ``` Enable Redis for caching and session management. Requires `redis` configuration. ```yaml flags: enable_redis: true ``` Use Pangolin DNS servers for client connections instead of external DNS servers for DNS delegation and CNAME setups. Used for clustering Pangolin nodes. REQUIRES EXTERNAL COMPONENTS. PLEASE CONTACT SUPPORT TO OBTAIN ACCESS BEFORE ENABLING. ```yaml flags: use_pangolin_dns: true ``` ### ACME Configuration Configuration for ACME certificate synchronization. Used in conjunction with `flags.enable_acme_cert_sync` to synchronize TLS certificates issued by Traefik (or another ACME client) into Pangolin for use on private resources. Path to the `acme.json` file or a directory containing more than one acme json file produced by Traefik (or another ACME client). Pangolin reads this file to extract certificates for synchronization and will look for all files in the specified directory if a directory is provided. The file must be in the format produced by Traefik's ACME integration. This file is typically mounted as a volume from your ACME client container. ```yaml acme: acme_json_path: "config/letsencrypt/acme.json" ``` Interval in milliseconds at which Pangolin polls the `acme.json` file for certificate changes. ```yaml acme: sync_interval_ms: 5000 ``` HTTP endpoint where Pangolin can pull SSL certificates from to load into the database. Provided in the following format: ```json [ { "wildcard": false, "altName": "subdomain.example.com", "certName": "subdomain.example.com", "commonName": "subdomain.example.com", "certFile": "", "keyFile": "" } ] ``` ```yaml acme: acme_http_endpoint: "http://controller-api.pangolin.svc.cluster.local/api/v1/certificates" ``` ### Branding Configuration Please refer to the [branding configuration documentation](/manage/branding).