christianlight
/
tutor
mirror of https://github.com/ChristianLight/tutor.git
7
0
Fork 0
Code Issues Releases Activity

Add big fat warning about podman-compose

This commit is contained in:
Régis Behmo 2020-09-21 10:35:36 +02:00
parent 0f50300ad6
commit 82b06034f9
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/podman.rst
View File

@ -6,8 +6,9 @@ You have the option of running Tutor with `Podman <https://podman.io/>`__, inste
The ``podman`` CLI aims to be fully compatible with the ``docker`` CLI, and ``podman-compose`` is meant to be a fully-compatible alias of ``docker-compose``. This means that you should be able to use together with Tutor, without making any changes to Tutor itself.
.. warning::
Some users have reported that while ``podman`` is a suitable drop-in replacement for ``docker`` for them, some compatibility issues do exist between ``podman-compose`` and ``docker-compose``. If you run into such compatibility issues, please report them on `Discourse <https://discuss.overhang.io/>`_.
Since this was written, it was discovered that there are major compatibility issues between ``podman-compose`` and ``docker-compose``. Thus, podman cannot be considered a drop-in replacement of Docker in the context of Tutor -- at least for running Open edX locally.
.. warning::
You should not attempt to run Tutor with Podman on a system that already has native ``docker`` installed. If you want to switch to ``podman`` using the aliases described here, you should uninstall (or at least stop) the native Docker daemon first.