kaven-utils - v6.1.8
    Preparing search index...

    Interface IStartRelayProxyOptions

    Options accepted by StartRelayProxyCore.

    interface IStartRelayProxyOptions {
        logger?: ILoggingAgent;
        origins?: IRelayProxyOriginOptions[];
        retryIndefinitely?: boolean;
        server?: IHostPort;
        serverTls?: TlsOptions;
        targets?: IRelayProxyTargetOptions[];
    }

    Hierarchy

    • ILoggable
      • IStartRelayProxyOptions
    Index
    logger? origins? retryIndefinitely? server? serverTls? targets?
    logger?: ILoggingAgent
    origins?: IRelayProxyOriginOptions[]

    Originator configurations. One local listener and relay client are started for every entry.

    retryIndefinitely?: boolean

    When true, the origin/target clients keep retrying transient relay connection errors forever (capped backoff) instead of giving up after a few attempts. Suitable for long-running daemons that should wait for the relay server to become reachable. Defaults to false.

    server?: IHostPort

    Where the relay server should listen. When omitted a relay server is not started by this call and both sides are expected to connect to an external one.

    serverTls?: TlsOptions

    TLS options for the relay server. When set, the server accepts TLS connections.

    targets?: IRelayProxyTargetOptions[]

    Target configurations. One relay client and destination tunnel are started for every entry.

    Settings
    Member Visibility

    On This Page
    Properties