diff --git a/docs/using.rst b/docs/using.rst index 879ea49c4..9ac745c61 100644 --- a/docs/using.rst +++ b/docs/using.rst @@ -50,11 +50,10 @@ Configuration file ------------------ It is possible to specify configuration file with -``letsencrypt-auto --config cli.ini`` (or shorter ``-c cli.ini``). For -instance, if you are a contributor, you might find the following -handy: +``letsencrypt-auto --config cli.ini`` (or shorter ``-c cli.ini``). An +example configuration file is shown below: -.. include:: ../examples/dev-cli.ini +.. include:: ../examples/cli.ini :code: ini By default, the following locations are searched: diff --git a/examples/cli.ini b/examples/cli.ini new file mode 100644 index 000000000..34fb8ab02 --- /dev/null +++ b/examples/cli.ini @@ -0,0 +1,24 @@ +# This is an example of the kind of things you can do in a configuration file. +# All flags used by the client can be configured here. Run Let's Encrypt with +# "--help" to learn more about the available options. + +# Use a 4096 bit RSA key instead of 2048 +rsa-key-size = 4096 + +# Always use the staging/testing server +server = https://acme-staging.api.letsencrypt.org/directory + +# Uncomment and update to register with the specified e-mail address +# email = foo@example.com + +# Uncomment to use a text interface instead of ncurses +# text = True + +# Uncomment to use the standalone authenticator on port 443 +# authenticator = standalone +# standalone-supported-challenges = dvsni + +# Uncomment to use the webroot authenticator. Replace webroot-path with the +# path to the public_html / webroot folder being served by your web server. +# authenticator = webroot +# webroot-path = /usr/share/nginx/html