Skip to content

Commit

Permalink
Merge 03a898f into 2502eb6
Browse files Browse the repository at this point in the history
  • Loading branch information
bartvanb committed Jan 12, 2024
2 parents 2502eb6 + 03a898f commit b68ac4e
Showing 1 changed file with 32 additions and 27 deletions.
59 changes: 32 additions & 27 deletions docs/server/optional.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ vantage6 server itself.
An application that will allow your server's users to interact more easily
with your vantage6 server.

:ref:`docker-registry`
A (private) Docker registry can be used to store algorithms but it is also
possible to use the (public) `Docker hub <https://hub.docker.com/>`__ to
upload your Docker images. For production scenarios, we recommend using a
private registry.

:ref:`eduvpn-install`
If you want to enable algorithm containers that are running on different
nodes, to directly communicate with one another, you require a VPN
Expand All @@ -18,10 +24,6 @@ vantage6 server itself.
improve, you may want to set up a RabbitMQ service which enables horizontal
scaling of the Vantage6 server.

:ref:`docker-registry`
A (private) Docker registry can be used to store algorithms but it is also
possible to use the (public) `Docker hub <https://hub.docker.com/>`__ to
upload your Docker images.

:ref:`smtp-server`
If you want to send emails to your users, e.g. to help them reset their
Expand Down Expand Up @@ -52,6 +54,32 @@ The UI is not compatible with older versions (<3.3) of vantage6.

Screenshot of the vantage6 UI

.. _docker-registry:

Docker registry
"""""""""""""""

A Docker registry or repository provides storage and versioning for Docker
images. Installing a private Docker registry is useful if you don't want to
share your algorithms. Also, a private registry may have security benefits,
for example, you can scan your images for vulnerabilities and you can limit
the range of IP addresses that the node may access to its server and the
private registry.

Docker Hub
~~~~~~~~~~

Docker itself provides a registry as a turn-key solution on Docker Hub.
Instructions for setting it up can be found here:
https://hub.docker.com/_/registry.

Harbor
~~~~~~

`Harbor <https://goharbor.io>`_ is another option for running a
registry. Harbor provides access control, a user interface and automated
scanning on vulnerabilities.

.. _eduvpn-install:

EduVPN
Expand Down Expand Up @@ -308,29 +336,6 @@ Be sure to create the user and vhost that you specify exist! Otherwise,
you can add them via the `RabbitMQ management
console <https://www.cloudamqp.com/blog/part3-rabbitmq-for-beginners_the-management-interface.html>`__.

.. _docker-registry:

Docker registry
"""""""""""""""

A Docker registry or repository provides storage and versioning for Docker
images. Installing a private Docker registry is useful if you want
don't want to share your algorithms.

Docker Hub
~~~~~~~~~~

Docker itself provides a registry as a turn-key solution on Docker Hub.
Instructions for setting it up can be found here:
https://hub.docker.com/_/registry.

Harbor
~~~~~~

`Harbor <https://goharbor.io>`_ is another option for running a
registry. Harbor provides access control, a user interface and automated
scanning on vulnerabilities.

.. _smtp-server:

SMTP server
Expand Down

0 comments on commit b68ac4e

Please sign in to comment.