From 00c9fa48ad897c89ab29180e8d44aab2eb4fba2e Mon Sep 17 00:00:00 2001 From: Guillaume Ayoub Date: Sat, 27 May 2017 12:47:52 +0200 Subject: [PATCH] Put the comments on empty lines Comments are not officially allowed at the end of content lines --- configuration.md | 3 ++- logging.md | 6 ++++-- setup.md | 12 ++++++++---- 3 files changed, 14 insertions(+), 7 deletions(-) diff --git a/configuration.md b/configuration.md index ae3e286a..e40799ba 100644 --- a/configuration.md +++ b/configuration.md @@ -10,7 +10,8 @@ command line arguments. An example configuration file looks like: ```ini [server] -hosts = 0.0.0.0:5232 # Bind all addresses +# Bind all addresses +hosts = 0.0.0.0:5232 [auth] type = htpasswd diff --git a/logging.md b/logging.md index f67931da..5381ee7f 100644 --- a/logging.md +++ b/logging.md @@ -32,12 +32,14 @@ keys = file keys = full [logger_root] -level = WARNING # Change this to DEBUG or INFO for higher verbosity. +# Change this to DEBUG or INFO for higher verbosity. +level = WARNING handlers = file [handler_file] class = FileHandler -args = ('/var/log/radicale/log',) # Specify the output file here. +# Specify the output file here. +args = ('/var/log/radicale/log',) formatter = full [formatter_full] diff --git a/setup.md b/setup.md index 7c6bdec4..96e12cda 100644 --- a/setup.md +++ b/setup.md @@ -53,7 +53,8 @@ Authentication can be enabled with the following configuration: [auth] type = htpasswd htpasswd_filename = /path/to/users -htpasswd_encryption = bcrypt # encryption method used in the htpasswd file +# encryption method used in the htpasswd file +htpasswd_encryption = bcrypt ``` ## Addresses @@ -89,11 +90,14 @@ The default values should be fine for most scenarios. ```ini [server] max_connections = 20 -max_content_length = 10000000 # 1 Megabyte -timeout = 10 # seconds +# 1 Megabyte +max_content_length = 10000000 +# 10 seconds +timeout = 10 [auth] -delay = 1 # Average delay after failed login attempts in seconds +# Average delay after failed login attempts in seconds +delay = 1 ``` ## Running as a service