Mercurial > p > roundup > code
comparison doc/installation.txt @ 7453:feb970243b97
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.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Mon, 05 Jun 2023 12:16:56 -0400 |
| parents | e7df82ae137d |
| children | a072331c843b |
comparison
equal
deleted
inserted
replaced
| 7452:bed28b64c581 | 7453:feb970243b97 |
|---|---|
| 114 You can either: | 114 You can either: |
| 115 | 115 |
| 116 * use a published container from hub.docker.com with | 116 * use a published container from hub.docker.com with |
| 117 ``rounduptracker/roundup:latest`` | 117 ``rounduptracker/roundup:latest`` |
| 118 | 118 |
| 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 | |
| 119 or | 124 or |
| 120 | 125 |
| 121 * Use steps 1-3 to `install the source`_ then | 126 * Use steps 1-3 to `install the source`_ then |
| 122 | 127 |
| 123 * build a local docker container using:: | 128 * build a local docker container using:: |
| 125 docker build -t roundup-app -f scripts/Docker/Dockerfile . | 130 docker build -t roundup-app -f scripts/Docker/Dockerfile . |
| 126 | 131 |
| 127 (see `Docker Support`_ and `Building a Docker Container`_ for more | 132 (see `Docker Support`_ and `Building a Docker Container`_ for more |
| 128 details) | 133 details) |
| 129 | 134 |
| 130 Start demo mode with [2]_:: | 135 and start demo mode with:: |
| 131 | 136 |
| 132 docker run --rm -p 127.0.0.1:8917:8080 --name roundup_demo -v \ | 137 docker run --rm -p 127.0.0.1:8917:8080 --name roundup_demo -v \ |
| 133 $PWD:/usr/src/app/tracker rounduptracker/roundup:latest demo | 138 $PWD:/usr/src/app/tracker roundup-app:latest demo |
| 134 | |
| 135 .. [2] Replace ``rounduptracker/roundup:latest`` with | |
| 136 ``roundup-app:latest`` if you built your own docker image. | |
| 137 | 139 |
| 138 This will create a ``demo`` subdirectory which is your tracker's | 140 This will create a ``demo`` subdirectory which is your tracker's |
| 139 home. It will also print the URL for exploring your new tracker. | 141 home. It will also print the URL for exploring your new tracker. |
| 140 | 142 |
| 141 .. caution:: | 143 .. caution:: |
| 260 zstd, brotli | 262 zstd, brotli |
| 261 To have roundup compress the returned data using one of these | 263 To have roundup compress the returned data using one of these |
| 262 algorithms, you can install one or more of zstd_ or brotli_. | 264 algorithms, you can install one or more of zstd_ or brotli_. |
| 263 Roundup's responses can always be compressed with gzip from the | 265 Roundup's responses can always be compressed with gzip from the |
| 264 Python standard library. Also nginx and various wsgi server can | 266 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 |
| 266 client. | 268 client. |
| 267 | 269 |
| 268 redis | 270 redis |
| 269 Storing ephemeral data: session keys, CSRF tokens etc. can be | 271 Storing ephemeral data: session keys, CSRF tokens etc. can be |
| 270 performance bottleneck. You can choose to deploy a Redis_ database | 272 performance bottleneck. You can choose to deploy a Redis_ database |
| 474 Note: running this command will *destroy any existing data in the | 476 Note: running this command will *destroy any existing data in the |
| 475 database*. In the case of MySQL and PostgreSQL, any existing database | 477 database*. In the case of MySQL and PostgreSQL, any existing database |
| 476 will be dropped and re-created. | 478 will be dropped and re-created. |
| 477 | 479 |
| 478 Once this is done, the tracker has been created. See the note in | 480 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 | 481 the `administration guide`_ on how to :ref:`initialise a |
| 480 prompted for the password or exposing the password on the command | 482 tracker without being prompted for the password <initpw>` or |
| 481 line. | 483 exposing the password on the command line. |
| 482 | 484 |
| 483 2. At this point, your tracker is set up, but doesn't have a nice user | 485 2. At this point, your tracker is set up, but doesn't have a nice user |
| 484 interface. To set that up, we need to `configure a web interface`_ and | 486 interface. To set that up, we need to `configure a web interface`_ and |
| 485 optionally `configure an email interface`_. If you want to try your | 487 optionally `configure an email interface`_. If you want to try your |
| 486 new tracker out, assuming the ``web`` setting in the | 488 new tracker out, assuming the ``web`` setting in the |