{"owner":"go-acme","repo":"lego","hasSkills":true,"totalSkillsCount":3,"totalTokensCount":4106,"categories":["anthropic-skill"],"hasMcp":false,"mcpConfig":null,"found":["docs/content/references/ref-flags/_index.md","docs/content/references/_index.md","docs/content/references/ref-file/_index.md"],"skills":{"docs/content/references/ref-flags/_index.md":"---\ntitle: \"Commands & Flags\"\ndate: 2019-03-03T16:39:46+01:00\ndraft: false\nweight: 7\nparams:\n  menuPre: '<i class=\"fa-solid fa-terminal\"></i> '\n---\n\nThis page lists all the available commands and flags.\n\n<!--more-->\n\n## Table of Contents\n\n- [lego]({{% ref \"references/ref-flags/#lego\" %}})\n- [lego run]({{% ref \"references/ref-flags/#lego-run\" %}})\n- [lego certificates revoke]({{% ref \"references/ref-flags/#lego-certificates-revoke\" %}})\n- [lego certificates list]({{% ref \"references/ref-flags/#lego-certificates-list\" %}})\n- [lego accounts register]({{% ref \"references/ref-flags/#lego-accounts-register\" %}})\n- [lego accounts recover]({{% ref \"references/ref-flags/#lego-accounts-recover\" %}})\n- [lego accounts keyrollover]({{% ref \"references/ref-flags/#lego-accounts-keyrollover\" %}})\n- [lego accounts list]({{% ref \"references/ref-flags/#lego-accounts-list\" %}})\n- [lego archives restore]({{% ref \"references/ref-flags/#lego-archives-restore\" %}})\n- [lego archives list]({{% ref \"references/ref-flags/#lego-archives-list\" %}})\n- [lego dnshelp]({{% ref \"references/ref-flags/#lego-dnshelp\" %}})\n- [lego migrate]({{% ref \"references/ref-flags/#lego-migrate\" %}})\n\n---\n\n{{% cmdhelp name=\"lego -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego run -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego certificates revoke -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego certificates list -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego accounts register -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego accounts recover -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego accounts keyrollover -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego accounts list -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego archives restore -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego archives list -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego dnshelp -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego migrate -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n","docs/content/references/_index.md":"---\ntitle: \"References\"\ndate: 2019-03-03T16:39:46+01:00\ndraft: false\nweight: 5\nparams:\n  menuPre: '<i class=\"fa-regular fa-bookmark\"></i> '\n---\n\nThis section contains references to command, flags, and the configuration file.\n\n<!--more-->\n\n{{% children type=\"card\" description=\"true\" %}}\n","docs/content/references/ref-file/_index.md":"---\ntitle: \"Configuration file\"\ndate: 2019-03-03T16:39:46+01:00\ndraft: false\nweight: 6\nparams:\n  menuPre: '<i class=\"fa-regular fa-file\"></i> '\n---\n\nThis describes the configuration file format.\n\n<!--more-->\n\nlego looks for configuration files in the following paths from the current working directory:\n\n- `.lego.yml`\n- `.lego.yaml`\n\nThe configuration file can be validated with the JSON Schema: [lego.jsonschema.json]({{% ref \"/\" %}}lego.jsonschema.json)\n\n## Global configuration\n\n```yaml\n# Path to the directory to use for storing the data.\n#\n# Default: .lego/\nstorage: /tmp/lego/\n\n# The network stack to use.\n# It can be:\n# - ipv6only\n# - ipv4only\n#\n# Default: both\nnetworkStack: ipv6only\n\n# The user agent to use when connecting to the ACME server.\n#\n# Default: information related to lego.\nuserAgent: foo\n```\n\n## Certificates\n\n```yaml\n# When a certificate definition is removed from the configuration file, the corresponding certificate files are archived.\n# The archives are deleted after 30 days.\ncertificates:\n  \n  # The ID/Name of the certificate.\n  myCert:\n    # The challenge type.\n    # It can be:\n    # 1. `http-01` (This is a special name to use the default HTTP challenge provider)\n    # 2. `tls-alpn-01` (This is a special name to use the default TLS-ALPN-01 challenge provider)\n    # 3. a reference to the ID of a challenge provider defined in the configuration section `challenges`.\n    #\n    # Required.\n    challenge: one\n    \n    # The account ID/Name.\n    # If there is no account defined in the configuration file, the default account is used.\n    # If there is only one account defined in the configuration file, the account ID can be omitted.\n    #\n    # Required.\n    account: foo\n    \n    # The key type used to generate the certificate.\n    # If not set, use the account key type, or EC256 if no account key type is defined.\n    #\n    # Required.\n    keyType: RSA2048\n    \n    # The domains to request a certificate for.\n    #\n    # Mutually exclusive with `csr`.\n    domains:\n      - example.com\n      - '*.example.com'\n    \n    # The path to a Certificate Signing Request (CSR) file.\n    #\n    # Mutually exclusive with `domains`.\n    csr: /tmp/foo.csr\n\n    # The preferred chain to use.\n    #\n    # Optional.\n    preferredChain: \"ISRG Root X1\"\n    \n    # The ACME server profile\n    #\n    # Optional.\n    profile: \"tls\"\n    \n    # Enable the use of the Common Name (CN) in the certificate.\n    # CN is deprecated and should not be used.\n    #\n    # Optional.\n    # Default: false\n    enableCommonName: true\n    \n    # The notBefore field in the certificate.\n    #\n    # Optional.\n    notBefore: \"\"\n\n    # The notAfter field in the certificate.\n    #\n    # Optional.\n    notAfter: \"\"\n    \n    # Do not create a certificate bundle by adding the issuers certificate to the new certificate.\n    #\n    # Default: false\n    noBundle: true\n\n    # Include the OCSP must staple TLS extension in the CSR and generated certificate.\n    # Only works if the CSR is generated by lego.\n    #\n    # Default: false\n    mustStaple: true\n    \n    # Force the authorizations to be relinquished even if the certificate request was successful.\n    #\n    # Default: false\n    alwaysDeactivateAuthorizations: true\n    \n    # Options for the certificate renewal.\n    #\n    # Optional.\n    renew:\n      # Reuse the private key if it exists.\n      #\n      # Optional.\n      # Default: false\n      reuseKey: true\n      \n      \n      # The number of days left on a certificate to renew it.\n      # \n      # By default, compute dynamically, based on the lifetime of the certificate(s), when to renew:\n      # use 1/3rd of the lifetime left, or 1/2 of the lifetime for short-lived certificates.\n      days: 1\n  \n      # Do not add a random sleep before the renewal.\n      #\n      # We do not recommend using this option if you are doing your renewals in an automated way.\n      #\n      # Default: false\n      disableRandomSleep: true\n      \n      # ARI configuration.\n      #\n      # Optional.\n      ari:\n        # Disable the ARI mechanism.\n        #\n        # Default: false\n        disable: true\n        \n        # The maximum duration you're willing to sleep for a renewal time returned by the renewalInfo endpoint.\n        # \n        # Default: 0s\n        waitToRenewDuration: 1m\n    \n    # Generate an additional .pfx (PKCS#12) file by concatenating the .key and .crt and issuer .crt files together.\n    # \n    # Optional.\n    pfx:\n      # The password used to encrypt the .pfx (PCKS#12) file.\n      #\n      # Required.\n      password: xxx\n      \n      # The encoding format to use when encrypting the .pfx (PCKS#12) file.\n      #\n      # Supported:\n      # - DES\n      # - RC2\n      # - SHA256\n      # - PBMAC1\n      #\n      # Optional.\n      # Default: RC2\n      format: PBMAC1\n```\n\n## Challenges\n\n\n```yml\n# The challenge configurations.\nchallenges:\n  # The ID/Name of the challenge.\n  #\n  # Required.\n  one:\n    # The HTTP-01 challenge configuration.\n    #\n    # Optional.\n    http:\n      # The address to listen on.\n      #\n      # Default: \":80\"\n      address: \":80\"\n      \n      # Delay between the starts of the HTTP server (use for HTTP-01 based challenges) and the validation of the challenge.\n      #\n      # Default: 0s\n      delay: 6s\n      \n      # Validate against this HTTP header when solving HTTP-01 based challenges behind a reverse proxy.\n      #\n      # Optional.\n      proxyHeader: Host\n\n      # The webroot folder to use for HTTP-01 based challenges to write directly to the .well-known/acme-challenge file.\n      # This disables the built-in server and expects the given directory to be publicly served with access to .well-known/acme-challenge\".\n      #\n      # Optional.\n      webroot: /tmp/webroot\n\n      # The memcached host(s) to use for HTTP-01 based challenges. Challenges will be written to all specified hosts.\n      #\n      # Optional.\n      memcachedHosts:\n        - memcached:11211\n      \n      # The S3 bucket name to use for HTTP-01 based challenges. Challenges will be written to the S3 bucket.\n      s3Bucket: 's3-bucket'\n\n  # The ID/Name of the challenge.\n  #\n  # Required.\n  two:\n    # The TLS-ALPN-01 challenge configuration.\n    #\n    # Optional.\n    tls:\n      # The address to listen on.\n      #\n      # Default: \":443\"\n      address: \":443\"\n\n      # Delay between the start of the TLS listener (use for TLSALPN-01 based challenges) and the validation of the challenge.\n      #\n      # Default: 0s\n      delay: 6s\n\n  # The ID/Name of the challenge.\n  #\n  # Required.\n  three:\n    # The DNS-01 challenge configuration.\n    #\n    # Optional.\n    dns:\n      # The DNS provider.\n      #\n      # Required.\n      provider: cloudflare\n      \n      # The path to the dotenv file containing the credentials.\n      #\n      # Optional.\n      envFile: /tmp/secrets/.env\n      \n      # The configuration related to propagation check.\n      #\n      # Optional.\n      propagation:\n        # By setting this option to true,\n        # disables the need to await propagation of the TXT record to all authoritative name servers.\n        #\n        # Default: false\n        disableAuthoritativeNameservers: true\n\n        # By setting this option to true,\n        # disables the need to await propagation of the TXT record to all recursive name servers (aka resolvers).\n        #\n        # Default: false\n        disableRecursiveNameservers: true\n\n        # Disables all the propagation checks of the TXT record and uses a wait duration instead.\n        #\n        # This option is strongly discouraged.\n        #\n        # Default: 0\n        wait: 5s\n\n      # Set the DNS timeout value to a specific value in seconds. Used only when performing authoritative name server queries.\n      #\n      # Default: 10\n      dnsTimeout: 30\n\n      # Set the resolvers to use for performing (recursive) CNAME resolving and apex domain determination.\n      #\n      # For DNS-01 challenge verification, the authoritative DNS server is queried directly.\n      #\n      # Supported syntax: host:port.\n      #\n      # Optional.\n      # The default is to use the system resolvers or Cloudflare's DNS resolvers if the system ones cannot be determined.\n      resolvers:\n        - 1.1.1.1:53\n\n  # The ID/Name of the challenge.\n  #\n  # Required.\n  four:\n    # The DNS-PERSIST-01 challenge configuration.\n    #\n    # Optional.\n    dnsPersist:\n      # Override the issuer-domain-name to use for DNS-PERSIST-01 when multiple are offered.\n      # Must be offered by the challenge.\n      #\n      # Optional.\n      issuerDomainName: example.com\n\n      # Set the optional `persistUntil` for DNS-PERSIST-01 records as an RFC3339 timestamp.\n      #\n      # Optional.\n      persistUntil: 2020-01-01T00:00:00Z\n\n      # The configuration related to propagation check.\n      #\n      # Optional.\n      propagation:\n        # By setting this option to true,\n        # disables the need to await propagation of the TXT record to all authoritative name servers.\n        #\n        # Default: false\n        disableAuthoritativeNameservers: true\n\n        # By setting this option to true,\n        # disables the need to await propagation of the TXT record to all recursive name servers (aka resolvers).\n        #\n        # Default: false\n        disableRecursiveNameservers: true\n\n        # Disables all the propagation checks of the TXT record and uses a wait duration instead.\n        #\n        # This option is strongly discouraged.\n        #\n        # Default: 0\n        wait: 5s\n```\n\n## Accounts\n\nDefining an account is optional: lego will create one for you by default on the Let's Encrypt ACME server.\n\nIf you want to use a different ACME server, or if you want to customize the account, you can define it in the configuration file.\n\n```yaml\n# When an account definition is removed from the configuration file, the corresponding account files are archived.\n# The archives are deleted after 30 days.\naccounts:\n  # The ID/Name of the account.\n  #\n  # Required.\n  myAccount:\n    # The ACME server.\n    #\n    # It can be:\n    # 1. a URL\n    # 2. a short code (see the shortcode section)\n    # 3. a reference to the ID of a server defined in the servers configuration section\n    #\n    # Default: https://acme-v02.api.letsencrypt.org/directory\n    server: https://example.com/dir\n    \n    # The account email.\n    #\n    # Optional.\n    email: foo@example.com\n    \n    # The key type used to generate the account private key.\n    #\n    # Default: EC256\n    keyType: RSA2048\n    \n    # The acceptance of the terms of service.\n    #\n    # Default: false\n    acceptsTermsOfService: true\n    \n    # The External Account Binding (EAB) configuration.\n    #\n    # Optional.\n    eab:\n      # The External Account Binding (EAB) KID.\n      #\n      # Required.\n      kid: foo\n      # The External Account Binding (EAB) HMAC key.\n      #\n      # Required.\n      hmacKey: foo\n```\n\n## Servers\n\n```yaml\nservers:\n  # The ID/Name of the server.\n  #\n  # Required.\n  myServer:\n    # The ACME server URL.\n    #\n    # Required.\n    url: https://example.com/dir\n\n    # ACME overall requests limit.\n    #\n    # Default: 18\n    overallRequestLimit: 7\n\n    # Skip the TLS verification of the ACME server.\n    #\n    # Default: false\n    tlsSkipVerify: true\n\n    # The HTTP timeout value to a specific value in seconds.\n    #\n    # Default: 30\n    httpTimeout: 60\n\n    # The certificate timeout value to a specific value in seconds.\n    # Only used when getting certificates.\n    #\n    # Default: 30\n    certTimeout: 60\n```\n\n## Logging\n\n\n```yml\n# Logging configuration.\n#\n# Optional.\nlog:\n  # The logging level.\n  #\n  # Default: info\n  level: debug\n  \n  # The logging format.\n  #\n  # Supported:\n  # - text\n  # - json\n  # - colored\n  #\n  # Default: colored\n  format: json\n```\n\n## Hooks\n\n```yml\n# Hooks configuration.\n#\n# Optional.\nhooks:\n  # The pre-hook.\n  #\n  # Optional.\n  pre:\n    # The command to execute.\n    #\n    # Required.\n    command: \"./my-pre-hook.sh\"\n    \n    # The timeout of the command.\n    #\n    # optional.\n    # Default: 2 minutes.\n    timeout: 3s\n  \n  # The deploy-hook.\n  #\n  # Optional.\n  deploy:\n    # The command to execute.\n    #\n    # Required.\n    command: \"./my-deploy-hook.sh\"\n\n    # The timeout of the command.\n    #\n    # optional.\n    # Default: 2 minutes.\n    timeout: 3s\n  \n  # The post-hook.\n  #\n  # Optional.\n  post:\n    # The command to execute.\n    #\n    # Required.\n    command: \"./my-post-hook.sh\"\n\n    # The timeout of the command.\n    #\n    # optional.\n    # Default: 2 minutes.\n    timeout: 3s\n```\n"},"files":{"docs/content/references/ref-flags/_index.md":"---\ntitle: \"Commands & Flags\"\ndate: 2019-03-03T16:39:46+01:00\ndraft: false\nweight: 7\nparams:\n  menuPre: '<i class=\"fa-solid fa-terminal\"></i> '\n---\n\nThis page lists all the available commands and flags.\n\n<!--more-->\n\n## Table of Contents\n\n- [lego]({{% ref \"references/ref-flags/#lego\" %}})\n- [lego run]({{% ref \"references/ref-flags/#lego-run\" %}})\n- [lego certificates revoke]({{% ref \"references/ref-flags/#lego-certificates-revoke\" %}})\n- [lego certificates list]({{% ref \"references/ref-flags/#lego-certificates-list\" %}})\n- [lego accounts register]({{% ref \"references/ref-flags/#lego-accounts-register\" %}})\n- [lego accounts recover]({{% ref \"references/ref-flags/#lego-accounts-recover\" %}})\n- [lego accounts keyrollover]({{% ref \"references/ref-flags/#lego-accounts-keyrollover\" %}})\n- [lego accounts list]({{% ref \"references/ref-flags/#lego-accounts-list\" %}})\n- [lego archives restore]({{% ref \"references/ref-flags/#lego-archives-restore\" %}})\n- [lego archives list]({{% ref \"references/ref-flags/#lego-archives-list\" %}})\n- [lego dnshelp]({{% ref \"references/ref-flags/#lego-dnshelp\" %}})\n- [lego migrate]({{% ref \"references/ref-flags/#lego-migrate\" %}})\n\n---\n\n{{% cmdhelp name=\"lego -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego run -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego certificates revoke -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego certificates list -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego accounts register -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego accounts recover -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego accounts keyrollover -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego accounts list -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego archives restore -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego archives list -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego dnshelp -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego migrate -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n","docs/content/references/_index.md":"---\ntitle: \"References\"\ndate: 2019-03-03T16:39:46+01:00\ndraft: false\nweight: 5\nparams:\n  menuPre: '<i class=\"fa-regular fa-bookmark\"></i> '\n---\n\nThis section contains references to command, flags, and the configuration file.\n\n<!--more-->\n\n{{% children type=\"card\" description=\"true\" %}}\n","docs/content/references/ref-file/_index.md":"---\ntitle: \"Configuration file\"\ndate: 2019-03-03T16:39:46+01:00\ndraft: false\nweight: 6\nparams:\n  menuPre: '<i class=\"fa-regular fa-file\"></i> '\n---\n\nThis describes the configuration file format.\n\n<!--more-->\n\nlego looks for configuration files in the following paths from the current working directory:\n\n- `.lego.yml`\n- `.lego.yaml`\n\nThe configuration file can be validated with the JSON Schema: [lego.jsonschema.json]({{% ref \"/\" %}}lego.jsonschema.json)\n\n## Global configuration\n\n```yaml\n# Path to the directory to use for storing the data.\n#\n# Default: .lego/\nstorage: /tmp/lego/\n\n# The network stack to use.\n# It can be:\n# - ipv6only\n# - ipv4only\n#\n# Default: both\nnetworkStack: ipv6only\n\n# The user agent to use when connecting to the ACME server.\n#\n# Default: information related to lego.\nuserAgent: foo\n```\n\n## Certificates\n\n```yaml\n# When a certificate definition is removed from the configuration file, the corresponding certificate files are archived.\n# The archives are deleted after 30 days.\ncertificates:\n  \n  # The ID/Name of the certificate.\n  myCert:\n    # The challenge type.\n    # It can be:\n    # 1. `http-01` (This is a special name to use the default HTTP challenge provider)\n    # 2. `tls-alpn-01` (This is a special name to use the default TLS-ALPN-01 challenge provider)\n    # 3. a reference to the ID of a challenge provider defined in the configuration section `challenges`.\n    #\n    # Required.\n    challenge: one\n    \n    # The account ID/Name.\n    # If there is no account defined in the configuration file, the default account is used.\n    # If there is only one account defined in the configuration file, the account ID can be omitted.\n    #\n    # Required.\n    account: foo\n    \n    # The key type used to generate the certificate.\n    # If not set, use the account key type, or EC256 if no account key type is defined.\n    #\n    # Required.\n    keyType: RSA2048\n    \n    # The domains to request a certificate for.\n    #\n    # Mutually exclusive with `csr`.\n    domains:\n      - example.com\n      - '*.example.com'\n    \n    # The path to a Certificate Signing Request (CSR) file.\n    #\n    # Mutually exclusive with `domains`.\n    csr: /tmp/foo.csr\n\n    # The preferred chain to use.\n    #\n    # Optional.\n    preferredChain: \"ISRG Root X1\"\n    \n    # The ACME server profile\n    #\n    # Optional.\n    profile: \"tls\"\n    \n    # Enable the use of the Common Name (CN) in the certificate.\n    # CN is deprecated and should not be used.\n    #\n    # Optional.\n    # Default: false\n    enableCommonName: true\n    \n    # The notBefore field in the certificate.\n    #\n    # Optional.\n    notBefore: \"\"\n\n    # The notAfter field in the certificate.\n    #\n    # Optional.\n    notAfter: \"\"\n    \n    # Do not create a certificate bundle by adding the issuers certificate to the new certificate.\n    #\n    # Default: false\n    noBundle: true\n\n    # Include the OCSP must staple TLS extension in the CSR and generated certificate.\n    # Only works if the CSR is generated by lego.\n    #\n    # Default: false\n    mustStaple: true\n    \n    # Force the authorizations to be relinquished even if the certificate request was successful.\n    #\n    # Default: false\n    alwaysDeactivateAuthorizations: true\n    \n    # Options for the certificate renewal.\n    #\n    # Optional.\n    renew:\n      # Reuse the private key if it exists.\n      #\n      # Optional.\n      # Default: false\n      reuseKey: true\n      \n      \n      # The number of days left on a certificate to renew it.\n      # \n      # By default, compute dynamically, based on the lifetime of the certificate(s), when to renew:\n      # use 1/3rd of the lifetime left, or 1/2 of the lifetime for short-lived certificates.\n      days: 1\n  \n      # Do not add a random sleep before the renewal.\n      #\n      # We do not recommend using this option if you are doing your renewals in an automated way.\n      #\n      # Default: false\n      disableRandomSleep: true\n      \n      # ARI configuration.\n      #\n      # Optional.\n      ari:\n        # Disable the ARI mechanism.\n        #\n        # Default: false\n        disable: true\n        \n        # The maximum duration you're willing to sleep for a renewal time returned by the renewalInfo endpoint.\n        # \n        # Default: 0s\n        waitToRenewDuration: 1m\n    \n    # Generate an additional .pfx (PKCS#12) file by concatenating the .key and .crt and issuer .crt files together.\n    # \n    # Optional.\n    pfx:\n      # The password used to encrypt the .pfx (PCKS#12) file.\n      #\n      # Required.\n      password: xxx\n      \n      # The encoding format to use when encrypting the .pfx (PCKS#12) file.\n      #\n      # Supported:\n      # - DES\n      # - RC2\n      # - SHA256\n      # - PBMAC1\n      #\n      # Optional.\n      # Default: RC2\n      format: PBMAC1\n```\n\n## Challenges\n\n\n```yml\n# The challenge configurations.\nchallenges:\n  # The ID/Name of the challenge.\n  #\n  # Required.\n  one:\n    # The HTTP-01 challenge configuration.\n    #\n    # Optional.\n    http:\n      # The address to listen on.\n      #\n      # Default: \":80\"\n      address: \":80\"\n      \n      # Delay between the starts of the HTTP server (use for HTTP-01 based challenges) and the validation of the challenge.\n      #\n      # Default: 0s\n      delay: 6s\n      \n      # Validate against this HTTP header when solving HTTP-01 based challenges behind a reverse proxy.\n      #\n      # Optional.\n      proxyHeader: Host\n\n      # The webroot folder to use for HTTP-01 based challenges to write directly to the .well-known/acme-challenge file.\n      # This disables the built-in server and expects the given directory to be publicly served with access to .well-known/acme-challenge\".\n      #\n      # Optional.\n      webroot: /tmp/webroot\n\n      # The memcached host(s) to use for HTTP-01 based challenges. Challenges will be written to all specified hosts.\n      #\n      # Optional.\n      memcachedHosts:\n        - memcached:11211\n      \n      # The S3 bucket name to use for HTTP-01 based challenges. Challenges will be written to the S3 bucket.\n      s3Bucket: 's3-bucket'\n\n  # The ID/Name of the challenge.\n  #\n  # Required.\n  two:\n    # The TLS-ALPN-01 challenge configuration.\n    #\n    # Optional.\n    tls:\n      # The address to listen on.\n      #\n      # Default: \":443\"\n      address: \":443\"\n\n      # Delay between the start of the TLS listener (use for TLSALPN-01 based challenges) and the validation of the challenge.\n      #\n      # Default: 0s\n      delay: 6s\n\n  # The ID/Name of the challenge.\n  #\n  # Required.\n  three:\n    # The DNS-01 challenge configuration.\n    #\n    # Optional.\n    dns:\n      # The DNS provider.\n      #\n      # Required.\n      provider: cloudflare\n      \n      # The path to the dotenv file containing the credentials.\n      #\n      # Optional.\n      envFile: /tmp/secrets/.env\n      \n      # The configuration related to propagation check.\n      #\n      # Optional.\n      propagation:\n        # By setting this option to true,\n        # disables the need to await propagation of the TXT record to all authoritative name servers.\n        #\n        # Default: false\n        disableAuthoritativeNameservers: true\n\n        # By setting this option to true,\n        # disables the need to await propagation of the TXT record to all recursive name servers (aka resolvers).\n        #\n        # Default: false\n        disableRecursiveNameservers: true\n\n        # Disables all the propagation checks of the TXT record and uses a wait duration instead.\n        #\n        # This option is strongly discouraged.\n        #\n        # Default: 0\n        wait: 5s\n\n      # Set the DNS timeout value to a specific value in seconds. Used only when performing authoritative name server queries.\n      #\n      # Default: 10\n      dnsTimeout: 30\n\n      # Set the resolvers to use for performing (recursive) CNAME resolving and apex domain determination.\n      #\n      # For DNS-01 challenge verification, the authoritative DNS server is queried directly.\n      #\n      # Supported syntax: host:port.\n      #\n      # Optional.\n      # The default is to use the system resolvers or Cloudflare's DNS resolvers if the system ones cannot be determined.\n      resolvers:\n        - 1.1.1.1:53\n\n  # The ID/Name of the challenge.\n  #\n  # Required.\n  four:\n    # The DNS-PERSIST-01 challenge configuration.\n    #\n    # Optional.\n    dnsPersist:\n      # Override the issuer-domain-name to use for DNS-PERSIST-01 when multiple are offered.\n      # Must be offered by the challenge.\n      #\n      # Optional.\n      issuerDomainName: example.com\n\n      # Set the optional `persistUntil` for DNS-PERSIST-01 records as an RFC3339 timestamp.\n      #\n      # Optional.\n      persistUntil: 2020-01-01T00:00:00Z\n\n      # The configuration related to propagation check.\n      #\n      # Optional.\n      propagation:\n        # By setting this option to true,\n        # disables the need to await propagation of the TXT record to all authoritative name servers.\n        #\n        # Default: false\n        disableAuthoritativeNameservers: true\n\n        # By setting this option to true,\n        # disables the need to await propagation of the TXT record to all recursive name servers (aka resolvers).\n        #\n        # Default: false\n        disableRecursiveNameservers: true\n\n        # Disables all the propagation checks of the TXT record and uses a wait duration instead.\n        #\n        # This option is strongly discouraged.\n        #\n        # Default: 0\n        wait: 5s\n```\n\n## Accounts\n\nDefining an account is optional: lego will create one for you by default on the Let's Encrypt ACME server.\n\nIf you want to use a different ACME server, or if you want to customize the account, you can define it in the configuration file.\n\n```yaml\n# When an account definition is removed from the configuration file, the corresponding account files are archived.\n# The archives are deleted after 30 days.\naccounts:\n  # The ID/Name of the account.\n  #\n  # Required.\n  myAccount:\n    # The ACME server.\n    #\n    # It can be:\n    # 1. a URL\n    # 2. a short code (see the shortcode section)\n    # 3. a reference to the ID of a server defined in the servers configuration section\n    #\n    # Default: https://acme-v02.api.letsencrypt.org/directory\n    server: https://example.com/dir\n    \n    # The account email.\n    #\n    # Optional.\n    email: foo@example.com\n    \n    # The key type used to generate the account private key.\n    #\n    # Default: EC256\n    keyType: RSA2048\n    \n    # The acceptance of the terms of service.\n    #\n    # Default: false\n    acceptsTermsOfService: true\n    \n    # The External Account Binding (EAB) configuration.\n    #\n    # Optional.\n    eab:\n      # The External Account Binding (EAB) KID.\n      #\n      # Required.\n      kid: foo\n      # The External Account Binding (EAB) HMAC key.\n      #\n      # Required.\n      hmacKey: foo\n```\n\n## Servers\n\n```yaml\nservers:\n  # The ID/Name of the server.\n  #\n  # Required.\n  myServer:\n    # The ACME server URL.\n    #\n    # Required.\n    url: https://example.com/dir\n\n    # ACME overall requests limit.\n    #\n    # Default: 18\n    overallRequestLimit: 7\n\n    # Skip the TLS verification of the ACME server.\n    #\n    # Default: false\n    tlsSkipVerify: true\n\n    # The HTTP timeout value to a specific value in seconds.\n    #\n    # Default: 30\n    httpTimeout: 60\n\n    # The certificate timeout value to a specific value in seconds.\n    # Only used when getting certificates.\n    #\n    # Default: 30\n    certTimeout: 60\n```\n\n## Logging\n\n\n```yml\n# Logging configuration.\n#\n# Optional.\nlog:\n  # The logging level.\n  #\n  # Default: info\n  level: debug\n  \n  # The logging format.\n  #\n  # Supported:\n  # - text\n  # - json\n  # - colored\n  #\n  # Default: colored\n  format: json\n```\n\n## Hooks\n\n```yml\n# Hooks configuration.\n#\n# Optional.\nhooks:\n  # The pre-hook.\n  #\n  # Optional.\n  pre:\n    # The command to execute.\n    #\n    # Required.\n    command: \"./my-pre-hook.sh\"\n    \n    # The timeout of the command.\n    #\n    # optional.\n    # Default: 2 minutes.\n    timeout: 3s\n  \n  # The deploy-hook.\n  #\n  # Optional.\n  deploy:\n    # The command to execute.\n    #\n    # Required.\n    command: \"./my-deploy-hook.sh\"\n\n    # The timeout of the command.\n    #\n    # optional.\n    # Default: 2 minutes.\n    timeout: 3s\n  \n  # The post-hook.\n  #\n  # Optional.\n  post:\n    # The command to execute.\n    #\n    # Required.\n    command: \"./my-post-hook.sh\"\n\n    # The timeout of the command.\n    #\n    # optional.\n    # Default: 2 minutes.\n    timeout: 3s\n```\n"},"items":[{"name":"_index.md","path":"docs/content/references/_index.md","rawUrl":"https://raw.githubusercontent.com/go-acme/lego/HEAD/docs/content/references/_index.md","title":"References Skill","category":"anthropic-skill","format":"markdown","content":"---\ntitle: \"References\"\ndate: 2019-03-03T16:39:46+01:00\ndraft: false\nweight: 5\nparams:\n  menuPre: '<i class=\"fa-regular fa-bookmark\"></i> '\n---\n\nThis section contains references to command, flags, and the configuration file.\n\n<!--more-->\n\n{{% children type=\"card\" description=\"true\" %}}\n","frontmatter":{"title":"References","date":"2019-03-03T16:39:46+01:00","draft":false,"weight":5,"params":{"menuPre":"<i class=\"fa-regular fa-bookmark\"></i> "}},"isInternal":false,"tokens":86,"sizeBytes":287},{"name":"_index.md","path":"docs/content/references/ref-file/_index.md","rawUrl":"https://raw.githubusercontent.com/go-acme/lego/HEAD/docs/content/references/ref-file/_index.md","title":"Ref-file Skill","category":"anthropic-skill","format":"markdown","content":"---\ntitle: \"Configuration file\"\ndate: 2019-03-03T16:39:46+01:00\ndraft: false\nweight: 6\nparams:\n  menuPre: '<i class=\"fa-regular fa-file\"></i> '\n---\n\nThis describes the configuration file format.\n\n<!--more-->\n\nlego looks for configuration files in the following paths from the current working directory:\n\n- `.lego.yml`\n- `.lego.yaml`\n\nThe configuration file can be validated with the JSON Schema: [lego.jsonschema.json]({{% ref \"/\" %}}lego.jsonschema.json)\n\n## Global configuration\n\n```yaml\n# Path to the directory to use for storing the data.\n#\n# Default: .lego/\nstorage: /tmp/lego/\n\n# The network stack to use.\n# It can be:\n# - ipv6only\n# - ipv4only\n#\n# Default: both\nnetworkStack: ipv6only\n\n# The user agent to use when connecting to the ACME server.\n#\n# Default: information related to lego.\nuserAgent: foo\n```\n\n## Certificates\n\n```yaml\n# When a certificate definition is removed from the configuration file, the corresponding certificate files are archived.\n# The archives are deleted after 30 days.\ncertificates:\n  \n  # The ID/Name of the certificate.\n  myCert:\n    # The challenge type.\n    # It can be:\n    # 1. `http-01` (This is a special name to use the default HTTP challenge provider)\n    # 2. `tls-alpn-01` (This is a special name to use the default TLS-ALPN-01 challenge provider)\n    # 3. a reference to the ID of a challenge provider defined in the configuration section `challenges`.\n    #\n    # Required.\n    challenge: one\n    \n    # The account ID/Name.\n    # If there is no account defined in the configuration file, the default account is used.\n    # If there is only one account defined in the configuration file, the account ID can be omitted.\n    #\n    # Required.\n    account: foo\n    \n    # The key type used to generate the certificate.\n    # If not set, use the account key type, or EC256 if no account key type is defined.\n    #\n    # Required.\n    keyType: RSA2048\n    \n    # The domains to request a certificate for.\n    #\n    # Mutually exclusive with `csr`.\n    domains:\n      - example.com\n      - '*.example.com'\n    \n    # The path to a Certificate Signing Request (CSR) file.\n    #\n    # Mutually exclusive with `domains`.\n    csr: /tmp/foo.csr\n\n    # The preferred chain to use.\n    #\n    # Optional.\n    preferredChain: \"ISRG Root X1\"\n    \n    # The ACME server profile\n    #\n    # Optional.\n    profile: \"tls\"\n    \n    # Enable the use of the Common Name (CN) in the certificate.\n    # CN is deprecated and should not be used.\n    #\n    # Optional.\n    # Default: false\n    enableCommonName: true\n    \n    # The notBefore field in the certificate.\n    #\n    # Optional.\n    notBefore: \"\"\n\n    # The notAfter field in the certificate.\n    #\n    # Optional.\n    notAfter: \"\"\n    \n    # Do not create a certificate bundle by adding the issuers certificate to the new certificate.\n    #\n    # Default: false\n    noBundle: true\n\n    # Include the OCSP must staple TLS extension in the CSR and generated certificate.\n    # Only works if the CSR is generated by lego.\n    #\n    # Default: false\n    mustStaple: true\n    \n    # Force the authorizations to be relinquished even if the certificate request was successful.\n    #\n    # Default: false\n    alwaysDeactivateAuthorizations: true\n    \n    # Options for the certificate renewal.\n    #\n    # Optional.\n    renew:\n      # Reuse the private key if it exists.\n      #\n      # Optional.\n      # Default: false\n      reuseKey: true\n      \n      \n      # The number of days left on a certificate to renew it.\n      # \n      # By default, compute dynamically, based on the lifetime of the certificate(s), when to renew:\n      # use 1/3rd of the lifetime left, or 1/2 of the lifetime for short-lived certificates.\n      days: 1\n  \n      # Do not add a random sleep before the renewal.\n      #\n      # We do not recommend using this option if you are doing your renewals in an automated way.\n      #\n      # Default: false\n      disableRandomSleep: true\n      \n      # ARI configuration.\n      #\n      # Optional.\n      ari:\n        # Disable the ARI mechanism.\n        #\n        # Default: false\n        disable: true\n        \n        # The maximum duration you're willing to sleep for a renewal time returned by the renewalInfo endpoint.\n        # \n        # Default: 0s\n        waitToRenewDuration: 1m\n    \n    # Generate an additional .pfx (PKCS#12) file by concatenating the .key and .crt and issuer .crt files together.\n    # \n    # Optional.\n    pfx:\n      # The password used to encrypt the .pfx (PCKS#12) file.\n      #\n      # Required.\n      password: xxx\n      \n      # The encoding format to use when encrypting the .pfx (PCKS#12) file.\n      #\n      # Supported:\n      # - DES\n      # - RC2\n      # - SHA256\n      # - PBMAC1\n      #\n      # Optional.\n      # Default: RC2\n      format: PBMAC1\n```\n\n## Challenges\n\n\n```yml\n# The challenge configurations.\nchallenges:\n  # The ID/Name of the challenge.\n  #\n  # Required.\n  one:\n    # The HTTP-01 challenge configuration.\n    #\n    # Optional.\n    http:\n      # The address to listen on.\n      #\n      # Default: \":80\"\n      address: \":80\"\n      \n      # Delay between the starts of the HTTP server (use for HTTP-01 based challenges) and the validation of the challenge.\n      #\n      # Default: 0s\n      delay: 6s\n      \n      # Validate against this HTTP header when solving HTTP-01 based challenges behind a reverse proxy.\n      #\n      # Optional.\n      proxyHeader: Host\n\n      # The webroot folder to use for HTTP-01 based challenges to write directly to the .well-known/acme-challenge file.\n      # This disables the built-in server and expects the given directory to be publicly served with access to .well-known/acme-challenge\".\n      #\n      # Optional.\n      webroot: /tmp/webroot\n\n      # The memcached host(s) to use for HTTP-01 based challenges. Challenges will be written to all specified hosts.\n      #\n      # Optional.\n      memcachedHosts:\n        - memcached:11211\n      \n      # The S3 bucket name to use for HTTP-01 based challenges. Challenges will be written to the S3 bucket.\n      s3Bucket: 's3-bucket'\n\n  # The ID/Name of the challenge.\n  #\n  # Required.\n  two:\n    # The TLS-ALPN-01 challenge configuration.\n    #\n    # Optional.\n    tls:\n      # The address to listen on.\n      #\n      # Default: \":443\"\n      address: \":443\"\n\n      # Delay between the start of the TLS listener (use for TLSALPN-01 based challenges) and the validation of the challenge.\n      #\n      # Default: 0s\n      delay: 6s\n\n  # The ID/Name of the challenge.\n  #\n  # Required.\n  three:\n    # The DNS-01 challenge configuration.\n    #\n    # Optional.\n    dns:\n      # The DNS provider.\n      #\n      # Required.\n      provider: cloudflare\n      \n      # The path to the dotenv file containing the credentials.\n      #\n      # Optional.\n      envFile: /tmp/secrets/.env\n      \n      # The configuration related to propagation check.\n      #\n      # Optional.\n      propagation:\n        # By setting this option to true,\n        # disables the need to await propagation of the TXT record to all authoritative name servers.\n        #\n        # Default: false\n        disableAuthoritativeNameservers: true\n\n        # By setting this option to true,\n        # disables the need to await propagation of the TXT record to all recursive name servers (aka resolvers).\n        #\n        # Default: false\n        disableRecursiveNameservers: true\n\n        # Disables all the propagation checks of the TXT record and uses a wait duration instead.\n        #\n        # This option is strongly discouraged.\n        #\n        # Default: 0\n        wait: 5s\n\n      # Set the DNS timeout value to a specific value in seconds. Used only when performing authoritative name server queries.\n      #\n      # Default: 10\n      dnsTimeout: 30\n\n      # Set the resolvers to use for performing (recursive) CNAME resolving and apex domain determination.\n      #\n      # For DNS-01 challenge verification, the authoritative DNS server is queried directly.\n      #\n      # Supported syntax: host:port.\n      #\n      # Optional.\n      # The default is to use the system resolvers or Cloudflare's DNS resolvers if the system ones cannot be determined.\n      resolvers:\n        - 1.1.1.1:53\n\n  # The ID/Name of the challenge.\n  #\n  # Required.\n  four:\n    # The DNS-PERSIST-01 challenge configuration.\n    #\n    # Optional.\n    dnsPersist:\n      # Override the issuer-domain-name to use for DNS-PERSIST-01 when multiple are offered.\n      # Must be offered by the challenge.\n      #\n      # Optional.\n      issuerDomainName: example.com\n\n      # Set the optional `persistUntil` for DNS-PERSIST-01 records as an RFC3339 timestamp.\n      #\n      # Optional.\n      persistUntil: 2020-01-01T00:00:00Z\n\n      # The configuration related to propagation check.\n      #\n      # Optional.\n      propagation:\n        # By setting this option to true,\n        # disables the need to await propagation of the TXT record to all authoritative name servers.\n        #\n        # Default: false\n        disableAuthoritativeNameservers: true\n\n        # By setting this option to true,\n        # disables the need to await propagation of the TXT record to all recursive name servers (aka resolvers).\n        #\n        # Default: false\n        disableRecursiveNameservers: true\n\n        # Disables all the propagation checks of the TXT record and uses a wait duration instead.\n        #\n        # This option is strongly discouraged.\n        #\n        # Default: 0\n        wait: 5s\n```\n\n## Accounts\n\nDefining an account is optional: lego will create one for you by default on the Let's Encrypt ACME server.\n\nIf you want to use a different ACME server, or if you want to customize the account, you can define it in the configuration file.\n\n```yaml\n# When an account definition is removed from the configuration file, the corresponding account files are archived.\n# The archives are deleted after 30 days.\naccounts:\n  # The ID/Name of the account.\n  #\n  # Required.\n  myAccount:\n    # The ACME server.\n    #\n    # It can be:\n    # 1. a URL\n    # 2. a short code (see the shortcode section)\n    # 3. a reference to the ID of a server defined in the servers configuration section\n    #\n    # Default: https://acme-v02.api.letsencrypt.org/directory\n    server: https://example.com/dir\n    \n    # The account email.\n    #\n    # Optional.\n    email: foo@example.com\n    \n    # The key type used to generate the account private key.\n    #\n    # Default: EC256\n    keyType: RSA2048\n    \n    # The acceptance of the terms of service.\n    #\n    # Default: false\n    acceptsTermsOfService: true\n    \n    # The External Account Binding (EAB) configuration.\n    #\n    # Optional.\n    eab:\n      # The External Account Binding (EAB) KID.\n      #\n      # Required.\n      kid: foo\n      # The External Account Binding (EAB) HMAC key.\n      #\n      # Required.\n      hmacKey: foo\n```\n\n## Servers\n\n```yaml\nservers:\n  # The ID/Name of the server.\n  #\n  # Required.\n  myServer:\n    # The ACME server URL.\n    #\n    # Required.\n    url: https://example.com/dir\n\n    # ACME overall requests limit.\n    #\n    # Default: 18\n    overallRequestLimit: 7\n\n    # Skip the TLS verification of the ACME server.\n    #\n    # Default: false\n    tlsSkipVerify: true\n\n    # The HTTP timeout value to a specific value in seconds.\n    #\n    # Default: 30\n    httpTimeout: 60\n\n    # The certificate timeout value to a specific value in seconds.\n    # Only used when getting certificates.\n    #\n    # Default: 30\n    certTimeout: 60\n```\n\n## Logging\n\n\n```yml\n# Logging configuration.\n#\n# Optional.\nlog:\n  # The logging level.\n  #\n  # Default: info\n  level: debug\n  \n  # The logging format.\n  #\n  # Supported:\n  # - text\n  # - json\n  # - colored\n  #\n  # Default: colored\n  format: json\n```\n\n## Hooks\n\n```yml\n# Hooks configuration.\n#\n# Optional.\nhooks:\n  # The pre-hook.\n  #\n  # Optional.\n  pre:\n    # The command to execute.\n    #\n    # Required.\n    command: \"./my-pre-hook.sh\"\n    \n    # The timeout of the command.\n    #\n    # optional.\n    # Default: 2 minutes.\n    timeout: 3s\n  \n  # The deploy-hook.\n  #\n  # Optional.\n  deploy:\n    # The command to execute.\n    #\n    # Required.\n    command: \"./my-deploy-hook.sh\"\n\n    # The timeout of the command.\n    #\n    # optional.\n    # Default: 2 minutes.\n    timeout: 3s\n  \n  # The post-hook.\n  #\n  # Optional.\n  post:\n    # The command to execute.\n    #\n    # Required.\n    command: \"./my-post-hook.sh\"\n\n    # The timeout of the command.\n    #\n    # optional.\n    # Default: 2 minutes.\n    timeout: 3s\n```\n","frontmatter":{"title":"Configuration file","date":"2019-03-03T16:39:46+01:00","draft":false,"weight":6,"params":{"menuPre":"<i class=\"fa-regular fa-file\"></i> "}},"isInternal":false,"tokens":3095,"sizeBytes":12499},{"name":"_index.md","path":"docs/content/references/ref-flags/_index.md","rawUrl":"https://raw.githubusercontent.com/go-acme/lego/HEAD/docs/content/references/ref-flags/_index.md","title":"Ref-flags Skill","category":"anthropic-skill","format":"markdown","content":"---\ntitle: \"Commands & Flags\"\ndate: 2019-03-03T16:39:46+01:00\ndraft: false\nweight: 7\nparams:\n  menuPre: '<i class=\"fa-solid fa-terminal\"></i> '\n---\n\nThis page lists all the available commands and flags.\n\n<!--more-->\n\n## Table of Contents\n\n- [lego]({{% ref \"references/ref-flags/#lego\" %}})\n- [lego run]({{% ref \"references/ref-flags/#lego-run\" %}})\n- [lego certificates revoke]({{% ref \"references/ref-flags/#lego-certificates-revoke\" %}})\n- [lego certificates list]({{% ref \"references/ref-flags/#lego-certificates-list\" %}})\n- [lego accounts register]({{% ref \"references/ref-flags/#lego-accounts-register\" %}})\n- [lego accounts recover]({{% ref \"references/ref-flags/#lego-accounts-recover\" %}})\n- [lego accounts keyrollover]({{% ref \"references/ref-flags/#lego-accounts-keyrollover\" %}})\n- [lego accounts list]({{% ref \"references/ref-flags/#lego-accounts-list\" %}})\n- [lego archives restore]({{% ref \"references/ref-flags/#lego-archives-restore\" %}})\n- [lego archives list]({{% ref \"references/ref-flags/#lego-archives-list\" %}})\n- [lego dnshelp]({{% ref \"references/ref-flags/#lego-dnshelp\" %}})\n- [lego migrate]({{% ref \"references/ref-flags/#lego-migrate\" %}})\n\n---\n\n{{% cmdhelp name=\"lego -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego run -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego certificates revoke -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego certificates list -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego accounts register -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego accounts recover -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego accounts keyrollover -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego accounts list -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego archives restore -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego archives list -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego dnshelp -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego migrate -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n","frontmatter":{"title":"Commands & Flags","date":"2019-03-03T16:39:46+01:00","draft":false,"weight":7,"params":{"menuPre":"<i class=\"fa-solid fa-terminal\"></i> "}},"isInternal":false,"tokens":925,"sizeBytes":3140}],"systemPromptSnippet":"<yakaai_skills repo=\"go-acme/lego\">\n<!-- File: docs/content/references/_index.md (Tokens: ~86 | Category: anthropic-skill) -->\n---\ntitle: \"References\"\ndate: 2019-03-03T16:39:46+01:00\ndraft: false\nweight: 5\nparams:\n  menuPre: '<i class=\"fa-regular fa-bookmark\"></i> '\n---\n\nThis section contains references to command, flags, and the configuration file.\n\n<!--more-->\n\n{{% children type=\"card\" description=\"true\" %}}\n\n<!-- File: docs/content/references/ref-file/_index.md (Tokens: ~3095 | Category: anthropic-skill) -->\n---\ntitle: \"Configuration file\"\ndate: 2019-03-03T16:39:46+01:00\ndraft: false\nweight: 6\nparams:\n  menuPre: '<i class=\"fa-regular fa-file\"></i> '\n---\n\nThis describes the configuration file format.\n\n<!--more-->\n\nlego looks for configuration files in the following paths from the current working directory:\n\n- `.lego.yml`\n- `.lego.yaml`\n\nThe configuration file can be validated with the JSON Schema: [lego.jsonschema.json]({{% ref \"/\" %}}lego.jsonschema.json)\n\n## Global configuration\n\n```yaml\n# Path to the directory to use for storing the data.\n#\n# Default: .lego/\nstorage: /tmp/lego/\n\n# The network stack to use.\n# It can be:\n# - ipv6only\n# - ipv4only\n#\n# Default: both\nnetworkStack: ipv6only\n\n# The user agent to use when connecting to the ACME server.\n#\n# Default: information related to lego.\nuserAgent: foo\n```\n\n## Certificates\n\n```yaml\n# When a certificate definition is removed from the configuration file, the corresponding certificate files are archived.\n# The archives are deleted after 30 days.\ncertificates:\n  \n  # The ID/Name of the certificate.\n  myCert:\n    # The challenge type.\n    # It can be:\n    # 1. `http-01` (This is a special name to use the default HTTP challenge provider)\n    # 2. `tls-alpn-01` (This is a special name to use the default TLS-ALPN-01 challenge provider)\n    # 3. a reference to the ID of a challenge provider defined in the configuration section `challenges`.\n    #\n    # Required.\n    challenge: one\n    \n    # The account ID/Name.\n    # If there is no account defined in the configuration file, the default account is used.\n    # If there is only one account defined in the configuration file, the account ID can be omitted.\n    #\n    # Required.\n    account: foo\n    \n    # The key type used to generate the certificate.\n    # If not set, use the account key type, or EC256 if no account key type is defined.\n    #\n    # Required.\n    keyType: RSA2048\n    \n    # The domains to request a certificate for.\n    #\n    # Mutually exclusive with `csr`.\n    domains:\n      - example.com\n      - '*.example.com'\n    \n    # The path to a Certificate Signing Request (CSR) file.\n    #\n    # Mutually exclusive with `domains`.\n    csr: /tmp/foo.csr\n\n    # The preferred chain to use.\n    #\n    # Optional.\n    preferredChain: \"ISRG Root X1\"\n    \n    # The ACME server profile\n    #\n    # Optional.\n    profile: \"tls\"\n    \n    # Enable the use of the Common Name (CN) in the certificate.\n    # CN is deprecated and should not be used.\n    #\n    # Optional.\n    # Default: false\n    enableCommonName: true\n    \n    # The notBefore field in the certificate.\n    #\n    # Optional.\n    notBefore: \"\"\n\n    # The notAfter field in the certificate.\n    #\n    # Optional.\n    notAfter: \"\"\n    \n    # Do not create a certificate bundle by adding the issuers certificate to the new certificate.\n    #\n    # Default: false\n    noBundle: true\n\n    # Include the OCSP must staple TLS extension in the CSR and generated certificate.\n    # Only works if the CSR is generated by lego.\n    #\n    # Default: false\n    mustStaple: true\n    \n    # Force the authorizations to be relinquished even if the certificate request was successful.\n    #\n    # Default: false\n    alwaysDeactivateAuthorizations: true\n    \n    # Options for the certificate renewal.\n    #\n    # Optional.\n    renew:\n      # Reuse the private key if it exists.\n      #\n      # Optional.\n      # Default: false\n      reuseKey: true\n      \n      \n      # The number of days left on a certificate to renew it.\n      # \n      # By default, compute dynamically, based on the lifetime of the certificate(s), when to renew:\n      # use 1/3rd of the lifetime left, or 1/2 of the lifetime for short-lived certificates.\n      days: 1\n  \n      # Do not add a random sleep before the renewal.\n      #\n      # We do not recommend using this option if you are doing your renewals in an automated way.\n      #\n      # Default: false\n      disableRandomSleep: true\n      \n      # ARI configuration.\n      #\n      # Optional.\n      ari:\n        # Disable the ARI mechanism.\n        #\n        # Default: false\n        disable: true\n        \n        # The maximum duration you're willing to sleep for a renewal time returned by the renewalInfo endpoint.\n        # \n        # Default: 0s\n        waitToRenewDuration: 1m\n    \n    # Generate an additional .pfx (PKCS#12) file by concatenating the .key and .crt and issuer .crt files together.\n    # \n    # Optional.\n    pfx:\n      # The password used to encrypt the .pfx (PCKS#12) file.\n      #\n      # Required.\n      password: xxx\n      \n      # The encoding format to use when encrypting the .pfx (PCKS#12) file.\n      #\n      # Supported:\n      # - DES\n      # - RC2\n      # - SHA256\n      # - PBMAC1\n      #\n      # Optional.\n      # Default: RC2\n      format: PBMAC1\n```\n\n## Challenges\n\n\n```yml\n# The challenge configurations.\nchallenges:\n  # The ID/Name of the challenge.\n  #\n  # Required.\n  one:\n    # The HTTP-01 challenge configuration.\n    #\n    # Optional.\n    http:\n      # The address to listen on.\n      #\n      # Default: \":80\"\n      address: \":80\"\n      \n      # Delay between the starts of the HTTP server (use for HTTP-01 based challenges) and the validation of the challenge.\n      #\n      # Default: 0s\n      delay: 6s\n      \n      # Validate against this HTTP header when solving HTTP-01 based challenges behind a reverse proxy.\n      #\n      # Optional.\n      proxyHeader: Host\n\n      # The webroot folder to use for HTTP-01 based challenges to write directly to the .well-known/acme-challenge file.\n      # This disables the built-in server and expects the given directory to be publicly served with access to .well-known/acme-challenge\".\n      #\n      # Optional.\n      webroot: /tmp/webroot\n\n      # The memcached host(s) to use for HTTP-01 based challenges. Challenges will be written to all specified hosts.\n      #\n      # Optional.\n      memcachedHosts:\n        - memcached:11211\n      \n      # The S3 bucket name to use for HTTP-01 based challenges. Challenges will be written to the S3 bucket.\n      s3Bucket: 's3-bucket'\n\n  # The ID/Name of the challenge.\n  #\n  # Required.\n  two:\n    # The TLS-ALPN-01 challenge configuration.\n    #\n    # Optional.\n    tls:\n      # The address to listen on.\n      #\n      # Default: \":443\"\n      address: \":443\"\n\n      # Delay between the start of the TLS listener (use for TLSALPN-01 based challenges) and the validation of the challenge.\n      #\n      # Default: 0s\n      delay: 6s\n\n  # The ID/Name of the challenge.\n  #\n  # Required.\n  three:\n    # The DNS-01 challenge configuration.\n    #\n    # Optional.\n    dns:\n      # The DNS provider.\n      #\n      # Required.\n      provider: cloudflare\n      \n      # The path to the dotenv file containing the credentials.\n      #\n      # Optional.\n      envFile: /tmp/secrets/.env\n      \n      # The configuration related to propagation check.\n      #\n      # Optional.\n      propagation:\n        # By setting this option to true,\n        # disables the need to await propagation of the TXT record to all authoritative name servers.\n        #\n        # Default: false\n        disableAuthoritativeNameservers: true\n\n        # By setting this option to true,\n        # disables the need to await propagation of the TXT record to all recursive name servers (aka resolvers).\n        #\n        # Default: false\n        disableRecursiveNameservers: true\n\n        # Disables all the propagation checks of the TXT record and uses a wait duration instead.\n        #\n        # This option is strongly discouraged.\n        #\n        # Default: 0\n        wait: 5s\n\n      # Set the DNS timeout value to a specific value in seconds. Used only when performing authoritative name server queries.\n      #\n      # Default: 10\n      dnsTimeout: 30\n\n      # Set the resolvers to use for performing (recursive) CNAME resolving and apex domain determination.\n      #\n      # For DNS-01 challenge verification, the authoritative DNS server is queried directly.\n      #\n      # Supported syntax: host:port.\n      #\n      # Optional.\n      # The default is to use the system resolvers or Cloudflare's DNS resolvers if the system ones cannot be determined.\n      resolvers:\n        - 1.1.1.1:53\n\n  # The ID/Name of the challenge.\n  #\n  # Required.\n  four:\n    # The DNS-PERSIST-01 challenge configuration.\n    #\n    # Optional.\n    dnsPersist:\n      # Override the issuer-domain-name to use for DNS-PERSIST-01 when multiple are offered.\n      # Must be offered by the challenge.\n      #\n      # Optional.\n      issuerDomainName: example.com\n\n      # Set the optional `persistUntil` for DNS-PERSIST-01 records as an RFC3339 timestamp.\n      #\n      # Optional.\n      persistUntil: 2020-01-01T00:00:00Z\n\n      # The configuration related to propagation check.\n      #\n      # Optional.\n      propagation:\n        # By setting this option to true,\n        # disables the need to await propagation of the TXT record to all authoritative name servers.\n        #\n        # Default: false\n        disableAuthoritativeNameservers: true\n\n        # By setting this option to true,\n        # disables the need to await propagation of the TXT record to all recursive name servers (aka resolvers).\n        #\n        # Default: false\n        disableRecursiveNameservers: true\n\n        # Disables all the propagation checks of the TXT record and uses a wait duration instead.\n        #\n        # This option is strongly discouraged.\n        #\n        # Default: 0\n        wait: 5s\n```\n\n## Accounts\n\nDefining an account is optional: lego will create one for you by default on the Let's Encrypt ACME server.\n\nIf you want to use a different ACME server, or if you want to customize the account, you can define it in the configuration file.\n\n```yaml\n# When an account definition is removed from the configuration file, the corresponding account files are archived.\n# The archives are deleted after 30 days.\naccounts:\n  # The ID/Name of the account.\n  #\n  # Required.\n  myAccount:\n    # The ACME server.\n    #\n    # It can be:\n    # 1. a URL\n    # 2. a short code (see the shortcode section)\n    # 3. a reference to the ID of a server defined in the servers configuration section\n    #\n    # Default: https://acme-v02.api.letsencrypt.org/directory\n    server: https://example.com/dir\n    \n    # The account email.\n    #\n    # Optional.\n    email: foo@example.com\n    \n    # The key type used to generate the account private key.\n    #\n    # Default: EC256\n    keyType: RSA2048\n    \n    # The acceptance of the terms of service.\n    #\n    # Default: false\n    acceptsTermsOfService: true\n    \n    # The External Account Binding (EAB) configuration.\n    #\n    # Optional.\n    eab:\n      # The External Account Binding (EAB) KID.\n      #\n      # Required.\n      kid: foo\n      # The External Account Binding (EAB) HMAC key.\n      #\n      # Required.\n      hmacKey: foo\n```\n\n## Servers\n\n```yaml\nservers:\n  # The ID/Name of the server.\n  #\n  # Required.\n  myServer:\n    # The ACME server URL.\n    #\n    # Required.\n    url: https://example.com/dir\n\n    # ACME overall requests limit.\n    #\n    # Default: 18\n    overallRequestLimit: 7\n\n    # Skip the TLS verification of the ACME server.\n    #\n    # Default: false\n    tlsSkipVerify: true\n\n    # The HTTP timeout value to a specific value in seconds.\n    #\n    # Default: 30\n    httpTimeout: 60\n\n    # The certificate timeout value to a specific value in seconds.\n    # Only used when getting certificates.\n    #\n    # Default: 30\n    certTimeout: 60\n```\n\n## Logging\n\n\n```yml\n# Logging configuration.\n#\n# Optional.\nlog:\n  # The logging level.\n  #\n  # Default: info\n  level: debug\n  \n  # The logging format.\n  #\n  # Supported:\n  # - text\n  # - json\n  # - colored\n  #\n  # Default: colored\n  format: json\n```\n\n## Hooks\n\n```yml\n# Hooks configuration.\n#\n# Optional.\nhooks:\n  # The pre-hook.\n  #\n  # Optional.\n  pre:\n    # The command to execute.\n    #\n    # Required.\n    command: \"./my-pre-hook.sh\"\n    \n    # The timeout of the command.\n    #\n    # optional.\n    # Default: 2 minutes.\n    timeout: 3s\n  \n  # The deploy-hook.\n  #\n  # Optional.\n  deploy:\n    # The command to execute.\n    #\n    # Required.\n    command: \"./my-deploy-hook.sh\"\n\n    # The timeout of the command.\n    #\n    # optional.\n    # Default: 2 minutes.\n    timeout: 3s\n  \n  # The post-hook.\n  #\n  # Optional.\n  post:\n    # The command to execute.\n    #\n    # Required.\n    command: \"./my-post-hook.sh\"\n\n    # The timeout of the command.\n    #\n    # optional.\n    # Default: 2 minutes.\n    timeout: 3s\n```\n\n<!-- File: docs/content/references/ref-flags/_index.md (Tokens: ~925 | Category: anthropic-skill) -->\n---\ntitle: \"Commands & Flags\"\ndate: 2019-03-03T16:39:46+01:00\ndraft: false\nweight: 7\nparams:\n  menuPre: '<i class=\"fa-solid fa-terminal\"></i> '\n---\n\nThis page lists all the available commands and flags.\n\n<!--more-->\n\n## Table of Contents\n\n- [lego]({{% ref \"references/ref-flags/#lego\" %}})\n- [lego run]({{% ref \"references/ref-flags/#lego-run\" %}})\n- [lego certificates revoke]({{% ref \"references/ref-flags/#lego-certificates-revoke\" %}})\n- [lego certificates list]({{% ref \"references/ref-flags/#lego-certificates-list\" %}})\n- [lego accounts register]({{% ref \"references/ref-flags/#lego-accounts-register\" %}})\n- [lego accounts recover]({{% ref \"references/ref-flags/#lego-accounts-recover\" %}})\n- [lego accounts keyrollover]({{% ref \"references/ref-flags/#lego-accounts-keyrollover\" %}})\n- [lego accounts list]({{% ref \"references/ref-flags/#lego-accounts-list\" %}})\n- [lego archives restore]({{% ref \"references/ref-flags/#lego-archives-restore\" %}})\n- [lego archives list]({{% ref \"references/ref-flags/#lego-archives-list\" %}})\n- [lego dnshelp]({{% ref \"references/ref-flags/#lego-dnshelp\" %}})\n- [lego migrate]({{% ref \"references/ref-flags/#lego-migrate\" %}})\n\n---\n\n{{% cmdhelp name=\"lego -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego run -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego certificates revoke -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego certificates list -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego accounts register -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego accounts recover -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego accounts keyrollover -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego accounts list -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego archives restore -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego archives list -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego dnshelp -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n\n---\n\n{{% cmdhelp name=\"lego migrate -h\" %}}\n\n{{% button href=\"references/ref-flags/\" style=\"transparent\" icon=\"angle-double-up\" %}}Back on Top{{% /button %}}\n</yakaai_skills>"}