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.

git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/roundup/trunk@4598 57a73879-2fb5-44c3-a270-3262357dd7e2

diff --git a/CHANGES.txt b/CHANGES.txt
index cc011fc6b04e438d8bbe7c695a989b5bf47003e4..3a071349d5f1762e9dddd241c7be30f0eccd6525 100644 (file)
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -89,6 +89,13 @@ Fixed:
   generation. Set this to a higher value on faster systems which want
   more security. Thanks to Eli Collins for implementing this (see
   issue2550688).
+- 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.
 
 2010-10-08 1.4.16 (r4541)
 

diff --git a/doc/admin_guide.txt b/doc/admin_guide.txt
index 95a15a8281a7d5a078e65b352b381cce791e441d..aa5c5cdb6840f927bff6c8da1619b430a33e6aca 100644 (file)
--- a/doc/admin_guide.txt
+++ b/doc/admin_guide.txt
@@ -74,7 +74,7 @@ The basic configuration file layout is as follows (take from the
 
     [main]
     port = 8080
-    ;hostname =
+    ;host =
     ;user =
     ;group =
     ;log_ip = yes
@@ -93,9 +93,13 @@ are as follows:
 
 **port**
   Defines the local TCP port to listen for clients on.
-**hostname**
-  Defines the local hostname to listen for clients on. Only required if
-  "localhost" is not sufficient.
+**host**
+  Defines the hostname or IP number to listen for clients on. Only
+  required if `localhost` is not sufficient. If left empty (as opposed
+  to no `host` keyword in the config-file) this will listen to all
+  network interfaces and is equivalent to an explicit address `0.0.0.0`.
+  The use of an empty string to listen to all interfaces is deprecated
+  and will go away in a future version.
 **user** and **group**
   Defines the Unix user and group to run the server as. Only work if the
   server is started as root.

diff --git a/doc/upgrading.txt b/doc/upgrading.txt
index a1bd77f9f18ad0cc0b9017c2ac9a51b780178edd..9a7d182aff2662157e32a1d79e1f01d994b9f2d3 100644 (file)
--- a/doc/upgrading.txt
+++ b/doc/upgrading.txt
@@ -16,13 +16,23 @@ steps.
 Migrating from 1.4.x to 1.4.17
 ==============================
 
-There is a new config-option 'migrate_passwords' in section 'web' to
+There is a new config-option `migrate_passwords` in section `web` to
 auto-migrate passwords at web-login time to a more secure storage
 scheme. Default for the new option is "yes" so if you don't want that
 passwords are auto-migrated to a more secure password scheme on user
 login, set this to "no" before running your tracker(s) after the
 upgrade.
 
+The standalone roundup-server now defaults to listening on localhost (no
+longer on all network interfaces). This will not affect you if you're
+already using a configuration file for roundup-server. If you are using
+an empty setting for the `host` parameter in the config-file you should
+explicitly put 0.0.0.0 there as the use of an empty string to specify
+listening to all interfaces is deprecated and will go away in a future
+version.  If you are starting the server without a configuration file
+and want to explicitly listen to all network interface, you should
+specify the -n option with the address `0.0.0.0`.
+
 Searching now requires either read-permission without a check method, or
 you will have to add a "Search" permission for a class or a list of
 properties for a class (if you want to allow searching). For the classic

diff --git a/roundup/scripts/roundup_server.py b/roundup/scripts/roundup_server.py
index 15c395182a4ac0ff7c1093b7f4228cd312012116..884b873f0473134448391a636711d54019818a89 100644 (file)
--- a/roundup/scripts/roundup_server.py
+++ b/roundup/scripts/roundup_server.py
@@ -465,9 +465,16 @@ class ServerConfig(configuration.Config):
 
     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 @@ Options:
  -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)