acme.sh cmd tool

acme.sh The acme protocol is implemented, which can generate free let's encrypt HTTPS certificate. It can connect with some cloud service providers seamlessly to realize automatic certificate generation and renewal. Here's how acme.sh Main parameters and introduction. You can generate the corresponding command line parameters directly on the page. Help you learn how to use it quickly acme.sh .

command

-h --help: Show this help message.

-v --version: Show version info.

--install: Install acme.sh to your system.

--uninstall: Uninstall acme.sh, and uninstall the cron job.

--upgrade: Upgrade acme.sh to the latest code from https://github.com/acmesh-official/acme.sh.

--issue: Issue a cert.

--deploy: Deploy the cert to your server.

-i --install-cert: Install the issued cert to apache/nginx or any other server.

-r --renew: Renew a cert.

--renew-all: Renew all the certs.

--revoke: Revoke a cert.

--remove: Remove the cert from list of certs known to acme.sh.

--list: List all the certs.

--to-pkcs12: Export the certificate and key to a pfx file.

--to-pkcs8: Convert to pkcs8 format.

--sign-csr: Issue a cert from an existing csr.

--show-csr: Show the content of a csr.

-ccr --create-csr: Create CSR, professional use.

--create-domain-key: Create an domain private key, professional use.

--update-account: Update account info.

--register-account: Register account key.

--deactivate-account: Deactivate the account.

--create-account-key: Create an account private key, professional use.

--install-cronjob: Install the cron job to renew certs, you don't need to call this. The 'install' command can automatically install the cron job.

--uninstall-cronjob: Uninstall the cron job. The 'uninstall' command can do this automatically.

--cron: Run cron job to renew all the certs.

--set-notify: Set the cron notification hook, level or mode.

--deactivate: Deactivate the domain authz, professional use.

--set-default-ca: Used with '--server', Set the default CA to use. See: https://github.com/acmesh-official/acme.sh/wiki/Server

Parameters

-d --domain: Specifies a domain, used to issue, renew or revoke etc.

--challenge-alias: The challenge domain alias for DNS alias mode. See: https://github.com/acmesh-official/acme.sh/wiki/DNS-alias-mode

--domain-alias: The domain alias for DNS alias mode. See: https://github.com/acmesh-official/acme.sh/wiki/DNS-alias-mode

--preferred-chain: If the CA offers multiple certificate chains, prefer the chain with an issuer matching this Subject Common Name. If no match, the default offered chain will be used. (default: empty) See: https://github.com/acmesh-official/acme.sh/wiki/Preferred-Chain

-f --force: Force install, force cert renewal or override sudo restrictions.

--staging --test: Use staging server, for testing.

--debug: Output debug info. Defaults to 1 if argument is omitted.

--output-insecure: Output all the sensitive messages. By default all the credentials/sensitive messages are hidden from the output/debug/log for security.

-w --webroot: Specifies the web root folder for web root mode.

--standalone: Use standalone mode.

--alpn: Use standalone alpn mode.

--stateless: Use stateless mode. See: https://github.com/acmesh-official/acme.sh/wiki/Stateless-Mode

--apache: Use apache mode.

--dns: Use dns manual mode or dns api. Defaults to manual mode when argument is omitted. See: https://github.com/acmesh-official/acme.sh/wiki/dnsapi

--dnssleep: The time in seconds to wait for all the txt records to propagate in dns api mode. It's not necessary to use this by default, acme.sh polls dns status by DOH automatically.

-k --keylength: Specifies the domain key length: 2048, 3072, 4096, 8192 or ec-256, ec-384, ec-521.

-ak --accountkeylength: Specifies the account key length: 2048, 3072, 4096

--log: Specifies the log file. Defaults to "/app/acme/acme.sh.log" if argument is omitted.

--log-level: Specifies the log level, default is 1.

--syslog: Syslog level, 0: disable syslog, 3: error, 6: info, 7: debug.

--eab-kid: Key Identifier for External Account Binding.

--eab-hmac-key: HMAC key for External Account Binding.

These parameters are to install the cert to nginx/apache or any other server after issue/renew a cert

--cert-file: Path to copy the cert file to after issue/renew..

--key-file: Path to copy the key file to after issue/renew.

--ca-file: Path to copy the intermediate cert file to after issue/renew.

--fullchain-file: Path to copy the fullchain cert file to after issue/renew.

--reloadcmd: Command to execute after issue/renew to reload the server.

--server: ACME Directory Resource URI. (default: https://acme-v02.api.letsencrypt.org/directory) See: https://github.com/acmesh-official/acme.sh/wiki/Server

--accountconf: Specifies a customized account config file.

--home: Specifies the home dir for acme.sh.

--cert-home: Specifies the home dir to save all the certs, only valid for '--install' command.

--config-home: Specifies the home dir to save all the configurations.

--useragent: Specifies the user agent string. it will be saved for future use too.

-m --email: Specifies the account email, only valid for the '--install' and '--update-account' command.

--accountkey: Specifies the account key path, only valid for the '--install' command.

--days: Specifies the days to renew the cert when using '--issue' command. The default value is 60 days.

--httpport: Specifies the standalone listening port. Only valid if the server is behind a reverse proxy or load balancer.

--tlsport: Specifies the standalone tls listening port. Only valid if the server is behind a reverse proxy or load balancer.

--local-address: Specifies the standalone/tls server listening address, in case you have multiple ip addresses.

--listraw: Only used for '--list' command, list the certs in raw format.

-se --stop-renew-on-error: Only valid for '--renew-all' command. Stop if one cert has error in renewal.

--insecure: Do not check the server certificate, in some devices, the api server's certificate may not be trusted.

--ca-bundle: Specifies the path to the CA certificate bundle to verify api server's certificate.

--ca-path: Specifies directory containing CA certificates in PEM format, used by wget or curl.

--no-cron: Only valid for '--install' command, which means: do not install the default cron job. In this case, the certs will not be renewed automatically.

--no-profile: Only valid for '--install' command, which means: do not install aliases to user profile.

--no-color: Do not output color text.

--force-color: Force output of color text. Useful for non-interactive use with the aha tool for HTML E-Mails.

--ecc: Specifies to use the ECC cert. Valid for '--install-cert', '--renew', '--revoke', '--to-pkcs12' and '--create-csr'

--csr: Specifies the input csr.

--pre-hook: Command to be run before obtaining any certificates.

--post-hook: Command to be run after attempting to obtain/renew certificates. Runs regardless of whether obtain/renew succeeded or failed.

--renew-hook: Command to be run after each successfully renewed certificate.

--deploy-hook: The hook file to deploy cert

--ocsp --ocsp-must-staple: Generate OCSP-Must-Staple extension.

--always-force-new-domain-key: Generate new domain key on renewal. Otherwise, the domain key is not changed by default.

--auto-upgrade: Valid for '--upgrade' command, indicating whether to upgrade automatically in future. Defaults to 1 if argument is omitted.

--listen-v4: Force standalone/tls server to listen at ipv4.

--listen-v6: Force standalone/tls server to listen at ipv6.

--openssl-bin: Specifies a custom openssl bin location.

--use-wget: Force to use wget, if you have both curl and wget installed.

--yes-I-know-dns-manual-mode-enough-go-ahead-please: Force use of dns manual mode. See: https://github.com/acmesh-official/acme.sh/wiki/dns-manual-mode

-b --branch: Only valid for '--upgrade' command, specifies the branch name to upgrade to.

--notify-level: Set the notification level: Default value is 2. 0: disabled, no notification will be sent. 1: send notifications only when there is an error. 2: send notifications when a cert is successfully renewed, or there is an error. 3: send notifications when a cert is skipped, renewed, or error.

--notify-mode: Set notification mode. Default value is 0. 0: Bulk mode. Send all the domain's notifications in one message(mail). 1: Cert mode. Send a message for every single cert.

--notify-hook: Set the notify hook

--revoke-reason: The reason for revocation, can be used in conjunction with the '--revoke' command. See: https://github.com/acmesh-official/acme.sh/wiki/revokecert

--password: Add a password to exported pfx file. Use with --to-pkcs12.

acme.sh Examples

正在开发

Other cmd tools

正在开发