Skip to content

Commit 48455ea

Browse files
committed
Link to docker support from main web index. Docker support changes.
With link from main web page going to docker support, add published docker image link and link to tags to the first paragraph to the Docker Support section. Some minor clarification of workding for docker tags. Typo fixes.
1 parent 90477d3 commit 48455ea

File tree

2 files changed

+23
-16
lines changed

2 files changed

+23
-16
lines changed

doc/installation.txt

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1618,18 +1618,23 @@ Docker Support
16181618
==============
16191619

16201620
If you don't want to install Roundup on a host, you can create a
1621-
Docker container. This installs Roundup using the `stand-alone web
1622-
server`_ method. This image only supports http. We suggest putting an
1621+
Docker container or use the `pre-built container on
1622+
hub.docker.com
1623+
<https://hub.docker.com/r/rounduptracker/roundup>`_. Docker hub
1624+
images support `multiple tags <#tags-for-dockerhub-docker-images>`_.
1625+
Docker images run Roundup using the `stand-alone web
1626+
server`_ method. The image only supports http. We suggest putting an
16231627
https terminating proxy in front of it.
16241628

16251629
This is a work in progress and patches to improve it are welcome. You
16261630
can find the docker config files under the `scripts/Docker` directory
16271631
of the source tree.
16281632

1629-
The dockerized Roundup is based on a 64 bit Alpine distribution. It
1630-
includes database drivers for anydbm, sqlite, MySQL and Postgresql
1631-
(Postgresl is untested). It also includes additional libraries that
1632-
are listed in `scripts/Docker/requirements.txt` (including redis).
1633+
The Roundup container uses the 64 bit Alpine Python distribution.
1634+
It includes database drivers for anydbm, SQLite, MySQL and
1635+
Postgresql (Postgresql is untested). It also includes additional
1636+
libraries that are listed in `scripts/Docker/requirements.txt`
1637+
(including redis client support).
16331638

16341639
Email support is a work in progress. Outgoing email to an external
16351640
SMTP server should work. Receiving email should work by using a
@@ -1935,8 +1940,10 @@ releases (not pre-releases) are tagged this way. For example, the
19351940
tags when 2.3.0 is released will be:
19361941

19371942
``rounduptracker/roundup:latest``
1938-
is a moving tag that tracks the latest build
1939-
with the newest version of Roundup.
1943+
is a moving tag that tracks the latest build with the newest
1944+
production version of Roundup using the current newest Alpine
1945+
release with the versions of Python packages at the time of
1946+
the build.
19401947

19411948
``rounduptracker/roundup:2.3.0``
19421949
is a moving tag that tracks the latest build
@@ -1959,12 +1966,12 @@ example: ``rounduptracker/roundup:2.3.0b1-devel``,
19591966
``rounduptracker/roundup:devel``
19601967

19611968
You should not assume that any ``devel`` tag is static. They are
1962-
mainly for use by Roundup developer/maintainer for testing. There
1963-
may be alternate tags ending with ``-devel`` to indicate builds
1964-
from specific Mercurial versions/hashes. Also the tag may be
1965-
overwritten to change the underlying Python libraries or
1966-
images. Unless you like the bleeding edge, these should not be
1967-
used in production.
1969+
mainly for use by Roundup developers/maintainers/testers for
1970+
testing. There may be alternate tags ending with ``-devel`` to
1971+
indicate builds from specific Mercurial versions/hashes. Also the
1972+
tag may be overwritten to change the underlying Python libraries
1973+
or images. Unless you like the bleeding edge, these should
1974+
**not** be used in production.
19681975

19691976
Maintenance
19701977
===========

website/www/index.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,8 +185,8 @@ Follow the source gratification mode with these steps (change the
185185
3. ``cd roundup-2.3.0``
186186
4. ``python3 demo.py``
187187

188-
(The source download can also be used to create a custom Docker
189-
image.)
188+
(The source download can also be used to `create a custom Docker
189+
image <docs/installation.html#docker-support>`_.)
190190

191191
Alternatively, you can install using a virtual environment with pip
192192
by:

0 commit comments

Comments
 (0)