diff roundup/scripts/roundup_server.py @ 4489:47bd330e3d17

Fix documentation for roundup-server about the 'host' parameter... ...as suggested in issue2550693, fixes the first part of this issue. Make 'localhost' the new default for this parameter, note the upgrading documentation of changed behaviour. We also deprecate the empty host parameter for binding to all interfaces now (still left in for compatibility). Thanks to Toni Mueller for providing the first version of this patch and discussing implementations.
author Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
date Fri, 15 Apr 2011 19:04:08 +0000
parents 207499c0a3ed
children 6e3e4f24c753
line wrap: on
line diff
--- a/roundup/scripts/roundup_server.py	Fri Apr 15 18:57:17 2011 +0000
+++ b/roundup/scripts/roundup_server.py	Fri Apr 15 19:04:08 2011 +0000
@@ -465,9 +465,16 @@
 
     SETTINGS = (
             ("main", (
-            (configuration.Option, "host", "",
+            (configuration.Option, "host", "localhost",
                 "Host name of the Roundup web server instance.\n"
-                "If empty, listen on all network interfaces."),
+                "If left unconfigured (no 'host' setting) the default\n"
+                "will be used.\n"
+                "If empty, listen on all network interfaces.\n"
+                "If you want to explicitly listen on all\n"
+                "network interfaces, the address 0.0.0.0 is a more\n"
+                "explicit way to achieve this, the use of an empty\n"
+                "string for this purpose is deprecated and will go away\n"
+                "in a future release."),
             (configuration.IntegerNumberOption, "port", DEFAULT_PORT,
                 "Port to listen on."),
             (configuration.NullableFilePathOption, "favicon", "favicon.ico",
@@ -734,7 +741,10 @@
  -h            print this text and exit
  -S            create or update configuration file and exit
  -C <fname>    use configuration file <fname>
- -n <name>     set the host name of the Roundup web server instance
+ -n <name>     set the host name of the Roundup web server instance,
+               specifies on which network interfaces to listen for
+               connections, defaults to localhost, use 0.0.0.0 to bind
+               to all network interfaces
  -p <port>     set the port to listen on (default: %(port)s)
  -l <fname>    log to the file indicated by fname instead of stderr/stdout
  -N            log client machine names instead of IP addresses (much slower)

Roundup Issue Tracker: http://roundup-tracker.org/