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

    Interface IRelayProxyConfig

    File-based configuration for the relay-proxy CLI command. The structure mirrors IProxyConfig: a SERVER block plus a CLIENTS array.

    6.1.8

    2026-07-28

    interface IRelayProxyConfig {
        CLIENT?: boolean;
        CLIENTS?: IRelayProxyClientConfig[];
        SERVER?: boolean;
        SERVER_CERT_DIR?: string;
        SERVER_CERT_FILE?: string;
        SERVER_HOST?: string;
        SERVER_PORT?: number;
        SERVER_TLS?: boolean;
    }
    Index
    CLIENT? CLIENTS? SERVER? SERVER_CERT_DIR? SERVER_CERT_FILE? SERVER_HOST? SERVER_PORT? SERVER_TLS?
    CLIENT?: boolean

    Whether any clients are enabled. When false, the CLIENTS array is ignored (server-only process).

    CLIENTS?: IRelayProxyClientConfig[]

    The relay clients to start. Every enabled entry is started in array order.

    SERVER?: boolean

    Whether to start the relay server in this process.

    SERVER_CERT_DIR?: string

    Directory where TLS certificates are auto-generated when SERVER_CERT_FILE is missing. Defaults to ./generated.

    SERVER_CERT_FILE?: string

    Path to a cert.json (a IGeneratedCertificateFiles dump) holding the CA, server, and client certificates. Auto-generated when missing.

    SERVER_HOST?: string

    Host the relay server binds to. Use 0.0.0.0 to accept remote peers.

    SERVER_PORT?: number

    Port the relay server binds to. 0 selects a free port.

    SERVER_TLS?: boolean

    When true, the relay server accepts TLS connections. Certificates are loaded from SERVER_CERT_FILE (or auto-generated into SERVER_CERT_DIR when missing). Clients must set CONNECT_TO_TLS: true to connect.

    Settings
    Member Visibility

    On This Page
    Properties