feat: allow setting URL hostname with -H option to roundup-demo

The underlying demo.py code already supported this.

Also update man page ading -H and fixing formatting for a number of
entries. Clarify that hostname can be used with -B to listen on the ip
address for that host.

Refactor port handling to reduce line length.

Author: rouilj

CHANGES.txt

@@ -186,6 +186,10 @@ Features:
   with the values from the dict. (John Rouillard)
 - add @group to rest interface collection queries. Useful when using
   optgroup in select elements. (John Rouillard)
+- roundup-demo can set the hostname in the URL using the -H
+  parameter. So you can start a demo tracker that is available from
+  your network using 'roundup-demo ... -B hostname -H hostname'. (John
+  Rouillard)
 
 2023-07-13 2.3.0
 

roundup/scripts/roundup_demo.py

@@ -71,12 +71,19 @@ def run():
     cli.add_argument('-B', '--bind_address',
                      default="127.0.0.1",
                      help=( "Choose address for server to listen at.\n"
-                            "Use 0.0.0.0 to bind to all addreses.\n"
+                            "Use 0.0.0.0 to bind to all addreses. Use\n"
+                            "the external name of the computer to bind to\n"
+                            "the external host interface.\n"
                             "Default: %(default)s.\n\n"))
     cli.add_argument('-b', '--backend_db',
                      choices=backends,
                      help=( "Choose backend database. Default: %s.\n\n" %
                             DEFAULT_BACKEND))
+    cli.add_argument('-H', '--hostname',
+                     default="localhost",
+                     help=( "Choose hostname for the server.\n"
+                            "Default: %(default)s.\n\n"
+                            ))
     cli.add_argument('-t', '--template',
                      choices=templates,
                      help="Use specified template. (*)\n\n")
@@ -87,8 +94,8 @@ def run():
     cli.add_argument('-P', '--urlport',
                      type=int,
                      help=( "Set docker external port. If using\n"
-                            "   docker ... -p 9090:8917 ..."
-                            "this should be set to 9090. "
+                            "   docker ... -p 9090:8917 ...\n"
+                            "this should be set to 9090.\n"
                             "Default: as selected by --port\n\n"))
     cli.add_argument('-V', '--version', action='version',
                      version='Roundup version %s'%roundup_version,
@@ -108,7 +115,8 @@ def run():
 
     cli.add_argument('nuke', nargs='?', metavar='nuke', choices=['nuke'],
                      help=( "The word 'nuke' will delete tracker and reset.\n"
-                            "E.G. %(prog)s -b sqlite -t classic ./mytracker nuke\n") % {"prog": sys.argv[0]})
+                            "E.G. %(prog)s -b sqlite \\ \n"
+                            "-t classic ./mytracker nuke\n") % {"prog": sys.argv[0]})
 
     cli_args = cli.parse_args()
 
@@ -168,9 +176,10 @@ def run():
                 print("Unknown template: %s. Exiting." % template)
                 exit(1)
         # install
+        url_port = cli_args.urlport or cli_args.port or DEFAULT_PORT
         demo.install_demo(home, backend,
                           admin.AdminTool().listTemplates()[template]['path'],
-                          use_port=cli_args.urlport or cli_args.port or DEFAULT_PORT)
+                          use_port=url_port, use_host=cli_args.hostname)
     else:
         # make sure that no options are specified that are only useful on initialization.
         if ( cli_args.backend or cli_args.template or

share/man/man1/roundup-demo.1

@@ -33,7 +33,7 @@ tracker using the sqlite backend.
 
 Show the help message and exit
 .TP
-\fB-b\fp \fIBIND_ADDRESS\fI, \fB--bind_address\fP \fIBIND_ADDRESS\fP
+\fB-B\fp \fIBIND_ADDRESS\fI, \fB--bind_address\fP \fIBIND_ADDRESS\fP
 
 Choose address for server to listen at. Use 0.0.0.0 to bind to all addreses.
 Default: 127.0.0.1.
@@ -51,15 +51,21 @@ sqlite. Available backends are subject to availability on your system.
 
 Use specified template when building tracker. (*)
 .TP
+\fB-h\fP \fIHOSTNAME\fP, \fB--hostname\fP \fIHOSTNAME\fP
+
+Set the hostname used in the URL. This does not make the server listen
+at the hostname. Use the hostname with \fB-B\fP to listen on that IP
+address.
+.TP
 \fB-p\fP \fIPORT\fP, \fB--port\fP \fIPORT\fP
 
 Listen at this port. Default: search for open port starting at 8917.
 .TP
-\fB-P\fP \fIURLPORT\fP, \fB--urlport\fP \fIURLPORT\fP When using
+\fB-P\fP \fIURLPORT\fP, \fB--urlport\fP \fIURLPORT\fP
 
-docker this option passes the docker external port to the demo
-instance. If using \fBdocker ... -p 9090:8917 ...\fP this should be
-set to \fB-P 9090\fP. Default: as selected by \fB--port\fP.
+When using docker this option passes the docker external port to the
+demo instance. If using \fBdocker ... -p 9090:8917 ...\fP this should
+be set to \fB-P 9090\fP. Default: as selected by \fB--port\fP.
 .TP
 \fB-V\fP, \fB--version\fP