github.com/prebid/prebid-server/v2@v2.18.0/docs/developers/configuration.md (about)

     1  # Configuration
     2  
     3  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`. 
     4  
     5  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.
     6  
     7  # Sections
     8  > [!IMPORTANT]
     9  > As we are still developing this guide, please refer to the [configuration structures in code](../../config/config.go) for a complete definition of the options.
    10  
    11  - [General](#general)
    12  - [Privacy](#privacy)
    13    - [GDPR](#gdpr)
    14  
    15  
    16  # General
    17  
    18  ### `external_url`
    19  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.
    20  
    21  <details>
    22    <summary>Example</summary>
    23    <p>
    24  
    25    JSON:
    26    ```
    27    {
    28      "external_url": "https://your-pbs-server.com"
    29    }
    30    ```
    31  
    32    YAML:
    33    ```
    34    external_url: https://your-pbs-server.com
    35    ```
    36  
    37    Environment Variable:
    38    ```
    39    PBS_EXTERNAL_URL: https://your-pbs-server.com
    40    ```
    41  
    42    </p>
    43  </details>
    44  
    45  ### `host`
    46  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.
    47  
    48  <details>
    49    <summary>Example</summary>
    50    <p>
    51  
    52    JSON:
    53    ```
    54    {
    55      "host": "127.0.0.1"
    56    }
    57    ```
    58  
    59    YAML:
    60    ```
    61    host: 127.0.0.1
    62    ```
    63  
    64    Environment Variable:
    65    ```
    66    PBS_HOST: 127.0.0.1
    67    ```
    68  
    69    </p>
    70  </details>
    71  
    72  ### `port`
    73  Integer value that specifies the port the server will listen to for connections. Defaults to `8000`.
    74  
    75  <details>
    76    <summary>Example</summary>
    77    <p>
    78  
    79    JSON:
    80    ```
    81    {
    82      "port": 8000
    83    }
    84    ```
    85  
    86    YAML:
    87    ```
    88    port: 8000
    89    ```
    90  
    91    Environment Variable:
    92    ```
    93    PBS_PORT: 8000
    94    ```
    95  
    96    </p>
    97  </details>
    98  
    99  # Privacy
   100  
   101  ## GDPR
   102  
   103  ### `gdpr.enabled`
   104  Boolean value that determines if GDPR processing for TCF signals is enabled. Defaults to `true`.
   105  <details>
   106    <summary>Example</summary>
   107    <p>
   108  
   109    JSON:
   110    ```
   111    {
   112      "gdpr": {
   113        "enabled": true
   114      }
   115    }
   116    ```
   117  
   118    YAML:
   119    ```
   120    gdpr:
   121      enabled: true
   122    ```
   123  
   124    Environment Variable:
   125    ```
   126    PBS_GDPR_ENABLED: true
   127    ```
   128  
   129    </p>
   130  </details>
   131  
   132  
   133  ### `gdpr.default_value` (required)
   134  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.
   135  <details>
   136    <summary>Example</summary>
   137    <p>
   138  
   139    JSON:
   140    ```
   141    {
   142      "gdpr": {
   143        "default_value": "0"
   144      }
   145    }
   146    ```
   147  
   148    YAML:
   149    ```
   150    gdpr:
   151      default_value: "0"
   152    ```
   153  
   154    Environment Variable:
   155    ```
   156    PBS_GDPR_DEFAULT_VALUE: 0
   157    ```
   158  
   159    </p>
   160  </details>