vod_proxy_header_name

The `vod_proxy_header_name` directive configures the name of the custom HTTP header used for VOD packaging within the NGINX-based VOD module.

Syntaxvod_proxy_header_name header_name;
Defaultnone
Contexthttp, server, location
Arguments1

Description

The vod_proxy_header_name directive is part of the NGINX-based VOD module and is used to specify a custom HTTP header name that will be included in requests to backend services during video on demand (VOD) processing. This allows for flexible configuration when integrating with upstream servers that may expect specific header names for functionality such as authentication, metadata passing, or caching control.

The directive accepts a single argument, which is the name of the HTTP header (for example, 'X-Custom-VOD-Header'). This header will then be sent along with the proxied requests for video streaming, allowing downstream services to operate based on the provided information. It is important to ensure that the header name does not conflict with standard HTTP headers to avoid unexpected behavior. When configuring multiple services in conjunction with this directive, proper care must be taken to distinguish between multiple VOD setups.

The context in which this directive can be used includes the http, server, and location blocks, ensuring that it can be tailored to specific scopes within the NGINX configuration. Misconfiguration might lead to requests failing to include expected headers, potentially resulting in degraded service or functionality.

Config Example

http {
    vod_proxy_header_name X-Custom-VOD-Header;
    server {
        location /vod {
            proxy_pass http://backend;
        }
    }
}

Ensure the header name does not conflict with standard HTTP headers.

Only use in appropriate contexts (http, server, location) to avoid configuration errors.

Test backend integration thoroughly to confirm headers are received as expected.

← Back to all directives