From 5ac682e478071074e35a9139b3403ad097717fb1 Mon Sep 17 00:00:00 2001 From: Brad Warren Date: Thu, 22 Oct 2015 17:13:57 -0700 Subject: [PATCH 1/5] Added example/cli.ini --- examples/cli.ini | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 examples/cli.ini diff --git a/examples/cli.ini b/examples/cli.ini new file mode 100644 index 000000000..3ea628937 --- /dev/null +++ b/examples/cli.ini @@ -0,0 +1,16 @@ +# This is an example of what you can do in a configuration file + +# make sure to use a valid email and domains! +email = foo@example.com +domains = example.com + +# Uncomment to use a text interface instead of ncurses +# text = True + +# Uncomment to use a 4096 bit RSA key instead of 2048 +# rsa-key-size = 4096 + +# 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 From c95ef0d4aa12ae27707aa36069d51e397a930091 Mon Sep 17 00:00:00 2001 From: Brad Warren Date: Fri, 23 Oct 2015 19:01:08 -0700 Subject: [PATCH 2/5] Updated examples/cli.ini --- examples/cli.ini | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/examples/cli.ini b/examples/cli.ini index 3ea628937..15fb89054 100644 --- a/examples/cli.ini +++ b/examples/cli.ini @@ -1,8 +1,7 @@ -# This is an example of what you can do in a configuration file +# This is an example of the kind of things you can do in a configuration file -# make sure to use a valid email and domains! -email = foo@example.com -domains = example.com +# 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 @@ -10,6 +9,13 @@ domains = example.com # Uncomment to use a 4096 bit RSA key instead of 2048 # rsa-key-size = 4096 +# Uncomment to always use the staging/testing server +# server = https://acme-staging.api.letsencrypt.org/directory + +# 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 From 4351d3d7ecd7f6cbaf65ba98da1ee260551a200b Mon Sep 17 00:00:00 2001 From: Brad Warren Date: Fri, 23 Oct 2015 19:10:56 -0700 Subject: [PATCH 3/5] Updated docs/using.rst --- docs/using.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) 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: From b2c27df19917897531e852933e319695d8666381 Mon Sep 17 00:00:00 2001 From: Brad Warren Date: Fri, 23 Oct 2015 19:15:00 -0700 Subject: [PATCH 4/5] Uncommented lines because CSS --- examples/cli.ini | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/examples/cli.ini b/examples/cli.ini index 15fb89054..f06cc51ef 100644 --- a/examples/cli.ini +++ b/examples/cli.ini @@ -1,17 +1,17 @@ # This is an example of the kind of things you can do in a configuration file +# 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 a 4096 bit RSA key instead of 2048 -# rsa-key-size = 4096 - -# Uncomment to always use the staging/testing server -# server = https://acme-staging.api.letsencrypt.org/directory - # Uncomment to use the standalone authenticator on port 443 # authenticator = standalone # standalone-supported-challenges = dvsni From 02159624bfbd39bb5029e5ba9c084b9218393e4d Mon Sep 17 00:00:00 2001 From: Brad Warren Date: Sat, 24 Oct 2015 09:20:52 -0700 Subject: [PATCH 5/5] Informed users about other options --- examples/cli.ini | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/examples/cli.ini b/examples/cli.ini index f06cc51ef..34fb8ab02 100644 --- a/examples/cli.ini +++ b/examples/cli.ini @@ -1,4 +1,6 @@ -# This is an example of the kind of things you can do in a configuration file +# 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