diff --git a/docs/podman.rst b/docs/podman.rst index 754d81f..91183e9 100644 --- a/docs/podman.rst +++ b/docs/podman.rst @@ -3,10 +3,12 @@ Running Tutor with Podman You have the option of running Tutor with `Podman `__, instead of the native Docker tools. This has some practical advantages: it does not require a running Docker daemon, and it enables you to run and build Docker images without depending on any system component running ``root``. As such, it is particularly useful for building Tutor images from CI pipelines. -The ``podman`` CLI aims to be fully compatible with the ``docker`` CLI, and ``podman-compose`` is a fully-compatible alias of ``docker-compose``. This means that you can use both together with Tutor, without making any changes to Tutor itself. +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:: - You should not attempt to run Tutor with Podman on a system that already has native ``docker`` and ``docker-compose`` installed. If you want to switch to ``podman`` and ``podman-compose`` using the aliases described here, uninstall the native Docker packages first. + 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 `_. + + 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. Enabling Podman