Private Configuration File

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 instead. The private config file is not required.

Setting up your `privateConfig.yml`

Here’s a basic example with common settings:

private-config.yml

flags:
  use_org_only_idp: false

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

app

object

Regional and base domain configuration for multi-region deployments.

Show properties

region

string

default:"default"

The region identifier for this Pangolin instance. Used for multi-region deployments.

app:
  region: "us-east-1"

Server Configuration

server

object

Advanced server configuration including encryption keys and API integrations.

Show properties

encryption_key_path

string

default:"./config/encryption.pem"

required

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.

server:
  encryption_key_path: "./config/encryption.pem"

The encryption_key_path must point to a valid RSA key file. Generate one using:

openssl genrsa -out encryption.pem 4096

Keep this key secure and backed up - it encrypts sensitive data in your database.

Redis Configuration

redis

object

Redis connection settings for caching, sessions, and rate limiting. Useful for clustering Pangolin nodes.

Show properties

host

string

required

Redis server hostname or IP address.

redis:
  host: "redis.example.com"

port

number

required

Redis server port (1-65535).

redis:
  port: 6379

password

string

Redis authentication password.

redis:
  password: "your-secure-password"

number

default:"0"

Redis database number (0-15 typically).

redis:
  db: 0

replicas

array

Array of read replica configurations for high-availability deployments.

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

Show replica properties

host

string

required

Replica server hostname.

port

number

required

Replica server port.

password

string

Replica authentication password.

number

default:"0"

Database number on replica.

Gerbil Tunnel Configuration

gerbil

object

Configuration for the Gerbil tunnel exit node integration.

Show properties

local_exit_node_reachable_at

string

default:"http://gerbil:3004"

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.

gerbil:
  local_exit_node_reachable_at: "http://gerbil:3004"

Feature Flags

flags

object

Feature toggles for advanced functionality.

Show properties

use_org_only_idp

boolean

default:"false"

Restrict identity provider (IdP) authentication to organization-level only.

flags:
  use_org_only_idp: true

enable_redis

boolean

default:"false"

Enable Redis for caching and session management. Requires redis configuration.

flags:
  enable_redis: true

use_pangolin_dns

boolean

default:"false"

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.

flags:
  use_pangolin_dns: true

Branding Configuration

Please refer to the branding configuration documentation.

About

Manage Pangolin

Self-host Pangolin

Careers

Development

Additional Resources

Private Configuration File

Setting up your `privateConfig.yml`

Reference

Application Settings

Server Configuration

Redis Configuration

Gerbil Tunnel Configuration

Feature Flags

Branding Configuration

About

Manage Pangolin

Self-host Pangolin

Careers

Development

Additional Resources

​Setting up your privateConfig.yml

​Reference

​Application Settings

​Server Configuration

​Redis Configuration

​Gerbil Tunnel Configuration

​Feature Flags

​Branding Configuration

Setting up your `privateConfig.yml`

Reference

Application Settings

Server Configuration

Redis Configuration

Gerbil Tunnel Configuration

Feature Flags

Branding Configuration