diff --git a/docs/developer_guide/docker_images.rst b/docs/developer_guide/docker_images.rst index 356d22b70..0310734a3 100644 --- a/docs/developer_guide/docker_images.rst +++ b/docs/developer_guide/docker_images.rst @@ -75,6 +75,7 @@ and can then run the entrypoint (equivalent to the usual command line usage) on +.. _developer_docker_details: Run Docker container on YAML conversion specification environment variable -------------------------------------------------------------------------- diff --git a/docs/user_guide/docker_demo.rst b/docs/user_guide/docker_demo.rst index 240440eba..e089b5748 100644 --- a/docs/user_guide/docker_demo.rst +++ b/docs/user_guide/docker_demo.rst @@ -123,4 +123,25 @@ VoilĂ ! If everything occurred successfully, you should see... RClone With Config Docker Demo ------------------------------ -# TODO +NeuroConv also supports a convenient Docker image for running data transfers via `Rclone `_. + +To use this image, you must first configure the remote locally by calling: + +.. code:: + + rclone config + +And following all interactive instructions (defaults are usually sufficient). + +The Docker image requires two environment variables to be set (see :ref:`developer_docker_details` for more details in a related process). + +- ``RCLONE_CONFIG``: The full file content of the rclone.conf file on your system. You can find this by calling ``rclone config file``. On UNIX, for example, you can set this variable using ``RCLONE_CONFIG=$(