diff doc/installation.txt @ 7707:36c3acb4b49b

feat: add help argument for docker image Brief help is reported when help argument is given to the docker container.
author John Rouillard <rouilj@ieee.org>
date Wed, 22 Nov 2023 00:46:10 -0500
parents 939e2edeab40
children a03f8f681992
line wrap: on
line diff
--- a/doc/installation.txt	Tue Nov 21 23:25:40 2023 -0500
+++ b/doc/installation.txt	Wed Nov 22 00:46:10 2023 -0500
@@ -1919,6 +1919,15 @@
 end of the ``docker run`` command are passed to the ``roundup-server``.
 These arguments **replace** the default arguments of ``issues=tracker``.
 
+Brief Help
+~~~~~~~~~~
+
+You can get help running the docker image::
+
+    docker run -it \
+        -v $PWD/tracker:/usr/src/app/tracker \
+        roundup-app:latest help
+
 Invoking a Shell
 ~~~~~~~~~~~~~~~~
 

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