@accelerated-software-development/caddy-api-client - v0.2.2
    Preparing search index...

    Interface BasicAuthRouteOptions

    Options for creating basic auth routes

    interface BasicAuthRouteOptions {
        accounts: { password: string; username: string }[];
        headers?: Record<string, string[]>;
        host: string;
        id?: string;
        path?: string;
        priority?: number;
        realm?: string;
        serviceId?: string;
        serviceType?: string;
        upstream: string | { dial: string }[];
    }
    Index

    Properties

    accounts headers? host id? path? priority? realm? serviceId? serviceType? upstream

    Properties

    accounts: { password: string; username: string }[]

    User accounts with bcrypt password hashes

    headers?: Record<string, string[]>

    Additional response headers

    host: string

    Host to match

    id?: string

    Route identifier

    path?: string

    Path to match (omit for domain-level auth)

    priority?: number

    Explicit priority (optional)

    realm?: string

    Authentication realm

    serviceId?: string

    Service identifier

    serviceType?: string

    Service type

    upstream: string | { dial: string }[]

    Upstream backend

    Settings

    Member Visibility

    On This Page

    Properties