Beignet API reference
    Preparing search index...

    Interface TrustedProxyOptions

    Trusted proxy configuration for request metadata.

    Beignet trusts no forwarding headers by default. Configure this only when the app is always behind a platform or reverse proxy that strips or normalizes these headers before they reach application code.

    interface TrustedProxyOptions {
        clientIp?: false | TrustedProxyClientIpSource;
        hostHeader?: string | false;
        protocolHeader?: string | false;
    }
    Index
    clientIp? hostHeader? protocolHeader?
    clientIp?: false | TrustedProxyClientIpSource

    Header source for the end-user client IP. Omit or set to false when no client-IP header should be trusted.

    hostHeader?: string | false

    Header that carries the external request host.

    Defaults to x-forwarded-host when trusted proxy handling is enabled.

    protocolHeader?: string | false

    Header that carries the external request protocol.

    Defaults to x-forwarded-proto when trusted proxy handling is enabled.

    Settings
    Member Visibility

    On This Page
    Properties