Skip to content

Commit f8261e0

Browse files
committed
feat: add help argument for docker image
Brief help is reported when help argument is given to the docker container.
1 parent 8eec516 commit f8261e0

File tree

2 files changed

+55
-0
lines changed

2 files changed

+55
-0
lines changed

doc/installation.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1919,6 +1919,15 @@ Once you have initialized your tracker, any arguments placed at the
19191919
end of the ``docker run`` command are passed to the ``roundup-server``.
19201920
These arguments **replace** the default arguments of ``issues=tracker``.
19211921

1922+
Brief Help
1923+
~~~~~~~~~~
1924+
1925+
You can get help running the docker image::
1926+
1927+
docker run -it \
1928+
-v $PWD/tracker:/usr/src/app/tracker \
1929+
roundup-app:latest help
1930+
19221931
Invoking a Shell
19231932
~~~~~~~~~~~~~~~~
19241933

scripts/Docker/roundup_start

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,52 @@ for tracker_spec in "$@"; do
142142
admin)
143143
shift
144144
exec roundup-admin "$@";;
145+
146+
help)
147+
sed -e 's/^\t\t//' <<EOH
148+
Example Usage:
149+
docker run --rm -it -p 127.0.0.1:8917:8080 \\
150+
-v $PWD:/usr/src/app/tracker \\
151+
--name roundup_demo docker/image ...
152+
153+
where ... is:
154+
155+
help - this output
156+
157+
demo ... - run a demo tracker with optional arguments
158+
tracker home is in '/usr/src/app/tracker/demo'
159+
directory.
160+
161+
admin ... - start roundup-admin shell or execute following
162+
arguments. Use '-i tracker/demo' to set tracker
163+
home.
164+
165+
shell - start a unix shell for advanced config
166+
167+
roundup-server(1) arguments - at minimum one or more
168+
tracker=tracker_home/directory
169+
specifications. See documentation for details.
170+
171+
if no arguments are supplied, it will start the guided
172+
install sequence. See documentation for details.
173+
174+
demo Mode Arguments:
175+
176+
one optional template name:
177+
classic, devel, jinja2, minimal, responsive
178+
179+
one optional database backend:
180+
sqlite, anydbm
181+
182+
the term 'nuke' to destroy demo tracker and start over
183+
184+
Other docker CLI Arguments:
185+
186+
--env SHELL_DEBUG=1 - enable debug output from startup script
187+
188+
EOH
189+
exit 0
190+
;;
145191
*)
146192
# we just continue. Allow setting CMD to:
147193
# -i index_template issue=tracker

0 commit comments

Comments
 (0)