Skip to content

Commit 9a41521

Browse files
committed
Clarify docker run commands and link to admin manual section
I had documented how to run a demo docker container and added a footnote on how to change it to run with the hub.docker.com container. It didn't really save any space and prevented cut/paste. Replace with two examples that can be properly cut and pasted. Link to the section in the admin guide that describes how to initialize a tracker unattended without disclosing the password on command line or in environment. Also fix a typo.
1 parent aa844da commit 9a41521

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

doc/installation.txt

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,11 @@ You can either:
116116
* use a published container from hub.docker.com with
117117
``rounduptracker/roundup:latest``
118118

119+
and start demo mode with::
120+
121+
docker run --rm -p 127.0.0.1:8917:8080 --name roundup_demo -v \
122+
$PWD:/usr/src/app/tracker rounduptracker/roundup:latest demo
123+
119124
or
120125

121126
* Use steps 1-3 to `install the source`_ then
@@ -127,13 +132,10 @@ or
127132
(see `Docker Support`_ and `Building a Docker Container`_ for more
128133
details)
129134

130-
Start demo mode with [2]_::
135+
and start demo mode with::
131136

132137
docker run --rm -p 127.0.0.1:8917:8080 --name roundup_demo -v \
133-
$PWD:/usr/src/app/tracker rounduptracker/roundup:latest demo
134-
135-
.. [2] Replace ``rounduptracker/roundup:latest`` with
136-
``roundup-app:latest`` if you built your own docker image.
138+
$PWD:/usr/src/app/tracker roundup-app:latest demo
137139

138140
This will create a ``demo`` subdirectory which is your tracker's
139141
home. It will also print the URL for exploring your new tracker.
@@ -262,7 +264,7 @@ zstd, brotli
262264
algorithms, you can install one or more of zstd_ or brotli_.
263265
Roundup's responses can always be compressed with gzip from the
264266
Python standard library. Also nginx and various wsgi server can
265-
compress the response from roundup as they transmit/proxy it to the
267+
compress the response from Roundup as they transmit/proxy it to the
266268
client.
267269

268270
redis
@@ -476,9 +478,9 @@ in the following steps.
476478
will be dropped and re-created.
477479

478480
Once this is done, the tracker has been created. See the note in
479-
the user_guide on how to initialise a tracker without being
480-
prompted for the password or exposing the password on the command
481-
line.
481+
the `administration guide`_ on how to :ref:`initialise a
482+
tracker without being prompted for the password <initpw>` or
483+
exposing the password on the command line.
482484

483485
2. At this point, your tracker is set up, but doesn't have a nice user
484486
interface. To set that up, we need to `configure a web interface`_ and

0 commit comments

Comments
 (0)