Mercurial > p > roundup > code
diff roundup/demo.py @ 7340:7b9bddda9d2d
Add support for demo mode in docker.
roundup/demo.py
Make changes to allow exposed port in docker to be specified
separately from the port that demo mode binds to. Also permit
bind address specification as well.
roundup/scripts/roundup_demo.py:
Update required by changes in demo.py. Also move away from
positional arguments to prefer flag arguments. Required for
passing port and host specification. Flake8 fixes.
share/man/man1/roundup-demo.1
Document use of option flags rather than positional
params. Other cleanups.
doc/installation.txt:
Document new docker modes: demo, shell and admin.
Update docs:
overview section - reorg, added template info
for the impatient section - added docker demo mode reference,
more docs on top level demo.py use.
new section on docker demo mode
removed getting roundup section. folded into installing roundup.
also prior for the impatient section describes how to download.
install via pip in venv recommended supported method
document all provided templates. not just minimal and classic.
added index references.
move sections around, decreased sectin depth, reformatting
scripts/Docker/roundup_healthcheck:
When running roundup-demo, there is no tracker spec. So default to
demo if no tracker=directory args found. Prevent's docker from
reporting an unhealthy container when running demo.
scripts/Docker/roundup_start:
implement demo, shell, admin docker modes.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 14 May 2023 09:43:53 -0400 |
| parents | 7147a4c833e9 |
| children | fb39200904a5 |
line wrap: on
line diff
--- a/roundup/demo.py Sun May 14 01:23:36 2023 -0400 +++ b/roundup/demo.py Sun May 14 09:43:53 2023 -0400 @@ -23,7 +23,7 @@ TRACKER_HOME = os.path.abspath('demo') -def install_demo(home, backend, template): +def install_demo(home, backend, template, use_port=None, use_host=None): """Install a demo tracker Parameters: @@ -91,9 +91,9 @@ os.remove(nosyreaction) # figure basic params for server - hostname = 'localhost' + hostname = use_host or 'localhost' # pick a fairly odd, random port - port = 8917 + port = use_port or 8917 while 1: print('Trying to set up web server on port %d ...' % port,) s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) @@ -135,14 +135,32 @@ db.close() -def run_demo(home): - """Run the demo tracker instance from its ``home`` directory""" +def run_demo(home, bind_addr=None, bind_port=None): + """Run the demo tracker instance from its ``home`` directory + + For running under docker, we need to split ports into + the port roundup-server binds to (usually 8080) and the + external mapping requested by docker to be used in external url's. + """ + print("Demo Tracker Home:", home) cfg = configuration.CoreConfig(home) url = cfg["TRACKER_WEB"] - hostname, port = urlparse.urlparse(url)[1].split(':') - port = int(port) + try: + hostname, port = urlparse.urlparse(url)[1].split(':') + except ValueError: + print("\nThe TRACKER_WEB url:\n\n %(url)s\n\nin\n\n" + " %(home)s/config.ini" + "\n\nis missing a port number.\n" + "\nAre you using demo mode to start a production tracker? " + "Try running\ndemo mode with a different directory. " + "Use roundup-server to serve\nproduction trackers. " + "Exiting.\n" % {'home': home, 'url': url}) + exit(1) + + bind_addr = bind_addr or hostname + port = int(bind_port or port) success_message = '''Server running - connect to: %(url)s 1. Log in as "demo"/"demo" or "admin"/"admin". @@ -159,7 +177,7 @@ ''' % dict(url=url, script=sys.argv[0], datadir=TRACKER_HOME) # disable command line processing in roundup_server - sys.argv = sys.argv[:1] + ['-p', str(port), '-n', hostname, 'demo=' + home] + sys.argv = sys.argv[:1] + ['-p', str(port), '-n', bind_addr, 'demo=' + home] roundup_server.run(success_message=success_message)