Mercurial > p > roundup > code
comparison doc/installation.txt @ 7500:c550b338616a
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.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 18 Jun 2023 18:24:37 -0400 |
| parents | a072331c843b |
| children | d401d6f51604 |
comparison
equal
deleted
inserted
replaced
| 7499:a072331c843b | 7500:c550b338616a |
|---|---|
| 1616 | 1616 |
| 1617 Docker Support | 1617 Docker Support |
| 1618 ============== | 1618 ============== |
| 1619 | 1619 |
| 1620 If you don't want to install Roundup on a host, you can create a | 1620 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 | 1621 Docker container or use the `pre-built container on |
| 1622 server`_ method. This image only supports http. We suggest putting an | 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 | |
| 1623 https terminating proxy in front of it. | 1627 https terminating proxy in front of it. |
| 1624 | 1628 |
| 1625 This is a work in progress and patches to improve it are welcome. You | 1629 This is a work in progress and patches to improve it are welcome. You |
| 1626 can find the docker config files under the `scripts/Docker` directory | 1630 can find the docker config files under the `scripts/Docker` directory |
| 1627 of the source tree. | 1631 of the source tree. |
| 1628 | 1632 |
| 1629 The dockerized Roundup is based on a 64 bit Alpine distribution. It | 1633 The Roundup container uses the 64 bit Alpine Python distribution. |
| 1630 includes database drivers for anydbm, sqlite, MySQL and Postgresql | 1634 It includes database drivers for anydbm, SQLite, MySQL and |
| 1631 (Postgresl is untested). It also includes additional libraries that | 1635 Postgresql (Postgresql is untested). It also includes additional |
| 1632 are listed in `scripts/Docker/requirements.txt` (including redis). | 1636 libraries that are listed in `scripts/Docker/requirements.txt` |
| 1637 (including redis client support). | |
| 1633 | 1638 |
| 1634 Email support is a work in progress. Outgoing email to an external | 1639 Email support is a work in progress. Outgoing email to an external |
| 1635 SMTP server should work. Receiving email should work by using a | 1640 SMTP server should work. Receiving email should work by using a |
| 1636 scheduled (cron) job to access email: | 1641 scheduled (cron) job to access email: |
| 1637 | 1642 |
| 1933 version-build, version, and ``latest`` tags. Only production | 1938 version-build, version, and ``latest`` tags. Only production |
| 1934 releases (not pre-releases) are tagged this way. For example, the | 1939 releases (not pre-releases) are tagged this way. For example, the |
| 1935 tags when 2.3.0 is released will be: | 1940 tags when 2.3.0 is released will be: |
| 1936 | 1941 |
| 1937 ``rounduptracker/roundup:latest`` | 1942 ``rounduptracker/roundup:latest`` |
| 1938 is a moving tag that tracks the latest build | 1943 is a moving tag that tracks the latest build with the newest |
| 1939 with the newest version of Roundup. | 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. | |
| 1940 | 1947 |
| 1941 ``rounduptracker/roundup:2.3.0`` | 1948 ``rounduptracker/roundup:2.3.0`` |
| 1942 is a moving tag that tracks the latest build | 1949 is a moving tag that tracks the latest build |
| 1943 of version 2.3.0 of Roundup. The Roundup software in this | 1950 of version 2.3.0 of Roundup. The Roundup software in this |
| 1944 build will match the 2.3.0 version released on PyPi, but the | 1951 build will match the 2.3.0 version released on PyPi, but the |
| 1957 development tags available. All tags will start with `devel`. For | 1964 development tags available. All tags will start with `devel`. For |
| 1958 example: ``rounduptracker/roundup:2.3.0b1-devel``, | 1965 example: ``rounduptracker/roundup:2.3.0b1-devel``, |
| 1959 ``rounduptracker/roundup:devel`` | 1966 ``rounduptracker/roundup:devel`` |
| 1960 | 1967 |
| 1961 You should not assume that any ``devel`` tag is static. They are | 1968 You should not assume that any ``devel`` tag is static. They are |
| 1962 mainly for use by Roundup developer/maintainer for testing. There | 1969 mainly for use by Roundup developers/maintainers/testers for |
| 1963 may be alternate tags ending with ``-devel`` to indicate builds | 1970 testing. There may be alternate tags ending with ``-devel`` to |
| 1964 from specific Mercurial versions/hashes. Also the tag may be | 1971 indicate builds from specific Mercurial versions/hashes. Also the |
| 1965 overwritten to change the underlying Python libraries or | 1972 tag may be overwritten to change the underlying Python libraries |
| 1966 images. Unless you like the bleeding edge, these should not be | 1973 or images. Unless you like the bleeding edge, these should |
| 1967 used in production. | 1974 **not** be used in production. |
| 1968 | 1975 |
| 1969 Maintenance | 1976 Maintenance |
| 1970 =========== | 1977 =========== |
| 1971 | 1978 |
| 1972 Read the `Tasks section of the administration guide | 1979 Read the `Tasks section of the administration guide |