Skip to content

Commit

Permalink
docs: add docker ownership admonition
Browse files Browse the repository at this point in the history
This commit adds a small admonition that explains how to access the
files in the mounted `data` folder on the local machine.
  • Loading branch information
rickstaa committed Feb 7, 2024
1 parent 2ba8031 commit 58a8e70
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/source/usage/docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,13 @@ Ensure to substitute ``/path/to/experiments`` and ``/path/to/data`` with the pre
.. note::
You can also use relative paths to mount directories. However, please ensure to prefix them with the relative path prefix ``./``. If this prefix is not used, Docker will interpret the path as a volume name and create a `Docker volume`_ with that name, which will then be mounted to the container.

.. tip::
By default, the' root' user owns the ``data`` folder created within the Docker container. Suppose you want to access the data from the host machine. In that case, you can change the ownership of the ``data`` folder to your user by running the following command:

.. code-block:: bash
sudo chown -R $USER:$USER /path/to/data
.. _Docker volume: https://docs.docker.com/storage/volumes/

Visualizing Experiments
Expand Down

0 comments on commit 58a8e70

Please sign in to comment.