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

    Interface PinggyOptions

    Configuration options for creating Pinggy tunnels.

    const options: PinggyOptions = {
      forwardTo: "localhost:3000",
      type: "http",
      debug: true,
      basicAuth: { "user": "password" }
    };
    interface PinggyOptions {
        allowPreflight?: boolean;
        basicAuth?: Record<string, string>;
        bearerAuth?: string[];
        cmd?: string;
        debug?: boolean;
        debuggerPort?: number;
        force?: boolean;
        forwardTo?: string;
        fullRequestUrl?: boolean;
        headerModification?: HeaderModification[];
        httpsOnly?: boolean;
        ipWhitelist?: string[];
        noReverseProxy?: boolean;
        serverAddress?: string;
        sniServerName?: string;
        ssl?: boolean;
        token?: string;
        type?: "tcp" | "tls" | "http" | "udp";
        xff?: boolean;
    }
    Index

    Properties

    allowPreflight? basicAuth? bearerAuth? cmd? debug? debuggerPort? force? forwardTo? fullRequestUrl? headerModification? httpsOnly? ipWhitelist? noReverseProxy? serverAddress? sniServerName? ssl? token? type? xff?

    Properties

    allowPreflight?: boolean

    Allow CORS preflight (OPTIONS) requests.

    false
    basicAuth?: Record<string, string>

    Basic authentication credentials (username: password).

    { "admin": "secret123", "user": "password" }
    bearerAuth?: string[]

    List of bearer authentication tokens.

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

    Optional command prefix for the tunnel.

    "--tcp"
    debug?: boolean

    Enable debug logging for this tunnel instance.

    false
    debuggerPort?: number

    Local port for web debugger.

    8080
    force?: boolean

    Force specific tunnel settings or bypass certain restrictions.

    false
    forwardTo?: string

    Local address to forward traffic to.

    "localhost:3000"
    fullRequestUrl?: boolean

    Forward the full request URL to the backend service.

    false
    headerModification?: HeaderModification[]

    List of header modification rules.

    HeaderModification

    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"]
    noReverseProxy?: boolean

    Disable reverse proxy behavior.

    false
    serverAddress?: string

    Server address to connect to.

    "connect.pinggy.io"
    sniServerName?: string

    SNI server name for SSL/TLS.

    "example.com"
    ssl?: boolean

    Whether to use SSL for tunnel setup.

    false
    token?: string

    Authentication token for the tunnel.

    "tk_123abc456def"
    type?: "tcp" | "tls" | "http" | "udp"

    Tunnel protocol type.

    "http"
    xff?: boolean

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

    false

    Settings

    Member Visibility

    On This Page

    Properties