Pinggy SDK - v0.4.1
    Preparing search index...

    Type Alias TunnelConfigurationV1

    Configuration options for creating Pinggy tunnels.

    const options: PinggyOptions = {
      forwarding: "localhost:3000",
      debug: true,
      basicAuth: [{ username: "user", password: "pass" }]
    };
    type TunnelConfigurationV1 = {
        allowPreflight?: boolean;
        autoReconnect?: boolean;
        basicAuth?: BasicAuthItem[];
        bearerTokenAuth?: string[];
        configId?: string;
        force?: boolean;
        forwarding?: string | ForwardingEntry[] | null;
        headerModification?: HeaderModification[];
        hostKeyCheck?: boolean;
        httpsOnly?: boolean;
        ipWhitelist?: string[];
        isQRCode?: boolean;
        keepAliveInterval?: number;
        maxReconnectAttempts?: number;
        name?: string;
        optional?: Optional;
        originalRequestUrl?: boolean;
        platformValue?: string;
        reconnectInterval?: number;
        reverseProxy?: boolean;
        serverAddress?: string;
        token?: string;
        version?: string;
        webDebugger?: string;
        xForwardedFor?: boolean;
    }
    Index

    Properties

    allowPreflight? autoReconnect? basicAuth? bearerTokenAuth? configId? force? forwarding? headerModification? hostKeyCheck? httpsOnly? ipWhitelist? isQRCode? keepAliveInterval? maxReconnectAttempts? name? optional? originalRequestUrl? platformValue? reconnectInterval? reverseProxy? serverAddress? token? version? webDebugger? xForwardedFor?

    Properties

    allowPreflight?: boolean

    Allow CORS preflight (OPTIONS) requests.

    false
    autoReconnect?: boolean

    Auto-reconnect configuration for the tunnel.

    false
    basicAuth?: BasicAuthItem[]

    Basic authentication credentials (username: password).

    [{ username: "user", password: "pass" }]

    BasicAuthItem

    bearerTokenAuth?: string[]

    List of bearer authentication tokens.

    ["token123", "token456"]
    configId?: string

    id of the config to map a configuration to a tunnel - used by app and remote management

    force?: boolean

    Force specific tunnel settings or bypass certain restrictions.

    false
    forwarding?: string | ForwardingEntry[] | null

    Forwarding can either be a string, or a list of objects. But it is required - at least empty string or empty list.

    "http://localhost:3000" or [{ address: "http://localhost:3000" }, { listenAddress: "0.tcp.pinggy.io:12345", address: "http://localhost:4000" }]
    headerModification?: HeaderModification[]

    List of header modification rules.

    HeaderModification

    hostKeyCheck?: boolean

    If false, adds -o StrictHostKeyChecking=no in SSH. Ignored by SDKs.

    httpsOnly?: boolean

    Only allow HTTPS connections to the tunnel.

    false
    ipWhitelist?: string[]

    List of whitelisted IP addresses that can access the tunnel.

    ["192.168.1.1", "10.0.0.1"]
    isQRCode?: boolean

    If true, display QR code in SSH command. Ignored by SDKs.

    keepAliveInterval?: number

    Keep-alive interval for SSH and heartbeat for SDK, in seconds. Set to 0 to disable.

    maxReconnectAttempts?: number

    Maximum number of reconnection attempts before giving up.

    20
    name?: string

    Name of the tunnel configuration. e.g. my RDP tunnel

    optional?: Optional

    Advanced SSL and additional configuration options.

    Optional

    originalRequestUrl?: boolean

    Forward the full request URL to the backend service.

    false
    platformValue?: string

    One of "bash", "cmd", "powershell", "zsh". Ignored by SDKs.

    reconnectInterval?: number

    Time interval (in seconds) between reconnection attempts.

    5
    reverseProxy?: boolean

    Disable reverse proxy behavior.

    false
    serverAddress?: string

    Server address to connect to.

    "connect.pinggy.io"
    token?: string

    Authentication token for the tunnel.

    "tk_123abc456def"
    version?: string

    Version of the Tunnel Config Spec. e.g. 1.0.

    webDebugger?: string

    Local address for web debugger.

    "localhost:8080"
    xForwardedFor?: boolean

    Enable X-Forwarded-For header to pass client IP information.

    false

    Settings

    Member Visibility

    On This Page

    Properties