cmd-sync-servers - v1.0.0
    Preparing search index...

    Interface SyncSessionOptions

    Options of SyncSession.open.

    interface SyncSessionOptions {
        env?: Readonly<Record<string, string | undefined>>;
        expectedCertificate?: string;
        expectedHostKey?: string;
        host: HostAdapter;
        logger?: Logger;
        registry: SiteRegistry;
        retryDelaysMs?: readonly number[];
        serverId?: string;
        siteId: string;
    }
    Index
    env? expectedCertificate? expectedHostKey? host logger? registry retryDelaysMs? serverId? siteId
    env?: Readonly<Record<string, string | undefined>>

    Where SYNC_SERVERS_PASSWORD and SSH_AUTH_SOCK are read. Default: the process environment.

    expectedCertificate?: string

    A certificate fingerprint to accept when the certificate does not verify (--trust-certificate).

    expectedHostKey?: string

    A host key fingerprint to accept when none is pinned (--host-key).

    host: HostAdapter

    Credentials, host key confirmation and prompts, from the program in charge.

    logger?: Logger

    Where the session logs. Default: the host's logger.

    registry: SiteRegistry

    The master list the site is read from, and where a pinned host key is saved.

    retryDelaysMs?: readonly number[]

    Waits before retries after transient failures. Default 1, 2 and 4 seconds.

    serverId?: string

    The server to use; the site's Remote server when absent.

    siteId: string

    The site to synchronize.

    Settings
    Member Visibility

    On This Page
    Properties