Skip to content

Latest commit

 

History

History
160 lines (123 loc) · 2.92 KB

configuration.md

File metadata and controls

160 lines (123 loc) · 2.92 KB
Raw

Configuration

Prebid Server is configured using environment variables, a pbs.json file, or a pbs.yaml file, in that order of precedence. Configuration files are read from either the application directory or /etc/config.

Upon starting, Prebid Server logs the resolved configuration to standard out with passwords and secrets redacted. If there's an error with the configuration, the application will log the error and exit.

Sections

Important

As we are still developing this guide, please refer to the configuration structures in code for a complete definition of the options.

General

external_url

String value that specifies the external url to reach your Prebid Server instance. It's used for event tracking and user sync callbacks, and is shared with bidders in outgoing requests at req.ext.prebid.server.externalurl. Defaults to empty.

Example

JSON:

{
  "external_url": "https://your-pbs-server.com"
}

YAML:

external_url: https://your-pbs-server.com

Environment Variable:

PBS_EXTERNAL_URL: https://your-pbs-server.com

host

String value that specifies the address the server will listen to for connections. If the value is empty, Prebid Server will listen on all available addresses, which is a common configuration. This value is also used for the Prometheus endpoint, if enabled. Defaults to empty.

Example

JSON:

{
  "host": "127.0.0.1"
}

YAML:

host: 127.0.0.1

Environment Variable:

PBS_HOST: 127.0.0.1

port

Integer value that specifies the port the server will listen to for connections. Defaults to 8000.

Example

JSON:

{
  "port": 8000
}

YAML:

port: 8000

Environment Variable:

PBS_PORT: 8000

Privacy

GDPR

gdpr.enabled

Boolean value that determines if GDPR processing for TCF signals is enabled. Defaults to true.

Example

JSON:

{
  "gdpr": {
    "enabled": true
  }
}

YAML:

gdpr:
  enabled: true

Environment Variable:

PBS_GDPR_ENABLED: true

gdpr.default_value (required)

String value that determines whether GDPR is enabled when no regulatory signal is available in the request. A value of "0" disables it by default and a value of "1" enables it. This is a required configuration value with no default.

Example

JSON:

{
  "gdpr": {
    "default_value": "0"
  }
}

YAML:

gdpr:
  default_value: "0"

Environment Variable:

PBS_GDPR_DEFAULT_VALUE: 0