Skip to content

Commit

Permalink
Docs: Update the image name for docker image (#6143)
Browse files Browse the repository at this point in the history
It was still pointing to the old name instead of the new `aiida-core-with-services`.

Cherry-pick: 5ca609b
  • Loading branch information
unkcpz authored and sphuber committed Nov 15, 2023
1 parent 0e5b1c7 commit 17507b4
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions docs/source/intro/run_docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
Run AiiDA via a Docker image
****************************

The AiiDA team maintains a `Docker <https://www.docker.com/>`__ image on `Docker Hub <https://hub.docker.com/r/aiidateam/aiida-core>`__.
The AiiDA team maintains a `Docker <https://www.docker.com/>`__ image on `Docker Hub <https://hub.docker.com/r/aiidateam/aiida-core-with-services>`__.
This image contains a fully pre-configured AiiDA environment which makes it particularly useful for learning and testing purposes.

.. caution::

All data stored in a container will persist only over the lifetime of that particular container unless you use volumes (see instructions below).
All data stored in a container will persist only over the lifetime of that particular container (i.e., removing the container will also purge the data) unless you use volumes (see instructions below).

.. grid:: 1
:gutter: 3
Expand All @@ -19,29 +19,19 @@ This image contains a fully pre-configured AiiDA environment which makes it part

To install Docker, please refer to the `official documentation <https://docs.docker.com/get-docker/>`__.

.. note::

If you are using Linux, you need to have root privileges to do `post-installation steps for the Docker Engine <https://docs.docker.com/engine/install/linux-postinstall/>`__.

.. grid-item-card:: Start container and use AiiDA interactively

First, pull the image:

.. parsed-literal::
$ docker pull aiidateam/aiida-core:latest
Then start the container with:
Start the container with (replace ``latest`` with the version you want to use, check the `Docker Hub <https://hub.docker.com/r/aiidateam/aiida-core-with-services/tags>`__ for available tags/versions):

.. parsed-literal::
$ docker run -it aiidateam/aiida-core:latest bash
$ docker run -it aiidateam/aiida-core-with-services:latest bash
You can specify a name for the container with the ``--name`` option for easier reference later on:

.. parsed-literal::
$ docker run -it --name aiida-container aiidateam/aiida-core:latest bash
$ docker run -it --name aiida-container aiidateam/aiida-core-with-services:latest bash
.. grid-item-card:: Check setup

Expand All @@ -59,6 +49,16 @@ This image contains a fully pre-configured AiiDA environment which makes it part
✓ rabbitmq: Connected as amqp://127.0.0.1?heartbeat=600
✓ daemon: Daemon is running as PID 1795 since 2020-05-20 02:54:00
.. grid-item-card:: Copy files from your computer to the container

To copy files from your computer to the container, use the ``docker cp`` command.

For example, to copy a file named ``test.txt`` from your current working directory to the ``/home/aiida`` path in the container, run:

.. code-block:: console
$ docker cp test.txt aiida-container:/home/aiida
.. grid-item-card:: Persist data across different containers

If you stop the container (`docker stop` or simply `Ctrl+D` from container) and start it again, any data you created will persist.
Expand Down

0 comments on commit 17507b4

Please sign in to comment.