.. _om-registries:

Registries
==========

The **Registries** page lists container registries: the places devices pull Docker
images from, such as Docker Hub or a private company registry. When a composition
(``docker-compose.yml``) refers to an image in a private registry, Orchestra uses the
login details saved here to pull it.

On the **Registries** page you can:

* see the registries of the tenant, with their names and URLs,
* search for a registry by name,
* :ref:`add a registry <om-add-registry>`,
* :ref:`edit a registry <om-edit-registry>`,
* :ref:`delete a registry <om-delete-registry>`.

.. figure:: images/registries-view.png
   :alt: Registries page
   :width: 100%
   :align: center

   Registries page

.. _om-add-registry:

Add a registry
--------------

1. Click the **+** button in the top right corner of the table.
2. In the **Add a new registry** window, fill in the fields:

   * **Name**: your own label for the registry, e.g. *Company Docker Hub*,
   * **URL**: the registry address,
   * **Login** and **Password**: the credentials to access the registry. Click the eye
     icon to show the password,
   * **Description** (optional): a note about the registry.

3. Click **Add**. To close the window without saving, click **Cancel**.

.. figure:: images/add-registry.png
   :alt: Add a new registry window
   :width: 70%
   :align: center

   Add a new registry

.. _om-edit-registry:

Edit a registry
---------------

1. On the **Registries** page, click the registry.
2. In the **Registry details** window, change its details.
3. Click **Save**.

.. figure:: images/edit-registry.png
   :alt: Registry details window
   :width: 70%
   :align: center

   Registry details

.. _om-delete-registry:

Delete a registry
-----------------

.. warning:: Deleting a registry revokes Orchestra's access to it. Compositions that use
   the registry and are already deployed keep working, but you can't update them.

1. On the **Registries** page, click on one of available registries.
2. In the **Registry details** window, click the red **Delete registry** button.
3. Confirm by clicking the red **Delete** button.

.. figure:: images/delete-registry.png
   :alt: Delete registry confirmation
   :width: 70%
   :align: center

   Delete registry confirmation