view website/www/docs.txt @ 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 5eadba24e148
children 79fd1bf20543
line wrap: on
line source

.. meta::
    :description:
        Table of contents for published documentation on the Roundup
        Issue Tracker.

Docs
====

.. note::
   The documentation is slowly being reorganized using the `Diataxis
   framework`_. Help with the reorganization is welcome. If a page you
   used to see is missing, try checking the `Other Docs
   <olderdocs.html>`_ page.

See: https://wiki.roundup-tracker.org/ReleaseErrata for fixes to
documentation.

.. _diataxis framework: https://diataxis.fr/

.. toctree::
   :maxdepth: 2

   docs/features
   docs/installation
   docs/upgrading
   docs/security
   docs/FAQ
   docs/user_guide
   docs/customizing
   docs/rest
   docs/xmlrpc
   docs/reference
   docs/glossary
   docs/admin_guide
   docs/license
   docs/acknowledgements
   olderdocs

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