[PATCH 2/2] docs: add note on deployment of patchwork on mac
Herakliusz Lipiec
hero24 at icloud.com
Wed Oct 30 06:09:11 AEDT 2024
Add notes on deplotment of Docker image for patchwork testing
usnng docker-compose on MacOs. Also adding a note on using
TAG variable to alter dockerfile image tag.
Signed-off-by: Herakliusz Lipiec <hero24 at icloud.com>
---
docs/development/installation.rst | 28 ++++++++++++++++++++++++++++
1 file changed, 28 insertions(+)
diff --git a/docs/development/installation.rst b/docs/development/installation.rst
index c33f768..04914f7 100644
--- a/docs/development/installation.rst
+++ b/docs/development/installation.rst
@@ -150,6 +150,34 @@ For more information on Docker itself, please refer to the `docker`_ and
.. _docker-compose: https://docs.docker.com/compose/install/
.. _post-install: https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user
+.. note::
+ If you are trying to run patchwork on Mac you need to edit the Dockerfile located in ``tools/docker``.
+ It has been observed that lines that create and switch user to ``patchwork`` cause problems on MacOS,
+ the solution that has been found to be working is to remove/comment these lines out.
+
+ If you encounter issues with accesing patchwork files in docker container after removal of above
+ lines, the mounted volume directory can be altered using:
+
+ .. code-block:: shell
+
+ $ PATCHWORK_DIR=/Users/<username>/path/to/patchwork docker-compose build
+
+.. note::
+ If you see an error like the below::
+
+ => ERROR [web internal] load metadata for ghcr.io/getpatchwork/pyenv:latest
+ 0.9s
+ ------
+ > [web internal] load metadata for ghcr.io/getpatchwork/pyenv:latest:
+
+ It is possible to change the tag used by passing TAG variable when running docker-compose like:
+
+ .. code-block:: shell
+
+ TAG=<tag-to-use> docker-compose build
+
+ Tags that currently are available for use be found here:
+ https://github.com/getpatchwork/pyenv/pkgs/container/pyenv
Manual Installation
-------------------
--
2.39.3 (Apple Git-146)
More information about the Patchwork
mailing list