@ipshipyard/libp2p-auto-tls
    Preparing search index...

    Interface AutoTLSInit

    interface AutoTLSInit {
        accountPrivateKeyBits?: number;
        accountPrivateKeyName?: string;
        acmeDirectory?: string;
        autoConfirmAddress?: boolean;
        certificateDatastoreKey?: string;
        certificatePrivateKeyBits?: number;
        certificatePrivateKeyName?: string;
        forgeDomain?: string;
        forgeEndpoint?: string;
        provisionDelay?: number;
        provisionRequestTimeout?: number;
        provisionTimeout?: number;
        renewThreshold?: number;
        userAgent?: string;
    }
    Index

    Properties

    accountPrivateKeyBits? accountPrivateKeyName? acmeDirectory? autoConfirmAddress? certificateDatastoreKey? certificatePrivateKeyBits? certificatePrivateKeyName? forgeDomain? forgeEndpoint? provisionDelay? provisionRequestTimeout? provisionTimeout? renewThreshold? userAgent?

    Properties

    accountPrivateKeyBits?: number

    How many bits the RSA private key for the account should be

    2048
    accountPrivateKeyName?: string

    The name the ACME account RSA private key is stored in the keychain with

    'auto-tls-acme-account-private-key'
    acmeDirectory?: string

    Which ACME service to use - examples are:

    'https://acme-v02.api.letsencrypt.org/directory'
    autoConfirmAddress?: boolean

    Any mapped addresses are added to the observed address list. These addresses require additional verification by the @libp2p/autonat protocol or similar before they are trusted.

    To skip this verification and trust them immediately pass true here

    false
    certificateDatastoreKey?: string

    The key the certificate is stored in the datastore under

    '/libp2p/auto-tls/certificate'
    certificatePrivateKeyBits?: number

    How many bits the RSA private key for the certificate should be

    2048
    certificatePrivateKeyName?: string

    The name the certificate RSA private key is stored in the keychain with

    'auto-tls-certificate-private-key'
    forgeDomain?: string

    The top level domain under which we will request certificate for

    'libp2p.direct'
    forgeEndpoint?: string

    Where to send requests to answer an ACME DNS challenge on our behalf - note that /v1/_acme-challenge will be added to the end of the URL

    'https://registration.libp2p.direct'
    provisionDelay?: number

    Certificates are acquired when the self:peer:update event fires, which happens when the node's addresses change. To avoid starting to map ports while multiple addresses are being added, the mapping function is debounced by this number of ms

    5000
    provisionRequestTimeout?: number

    How long asking the forge endpoint to answer a DNS challenge can take before we retry

    60_000
    provisionTimeout?: number

    How long to attempt to acquire a certificate before timing out in ms

    120_000
    renewThreshold?: number

    How long before the expiry of the certificate to renew it in ms, defaults to one day

    86_400_000
    userAgent?: string

    The User-Agent header sent during HTTP requests

    "js-libp2p/${version} node/${version}"

    Use nodeInfo.userAgent in the main libp2p config instead

    Settings

    Member Visibility

    On This Page

    Properties