From e4388088bcf75dc4c8fdc4d426d815235010f489 Mon Sep 17 00:00:00 2001 From: Stefan Bienert <stefan.bienert@unibas.ch> Date: Mon, 2 Mar 2020 17:07:15 +0100 Subject: [PATCH] Mention container registry in documentation/ REAMDE --- docker/README.rst | 13 ++++++++++++- modules/doc/install.rst | 6 ++++-- 2 files changed, 16 insertions(+), 3 deletions(-) diff --git a/docker/README.rst b/docker/README.rst index 517345d9c..93e58eb30 100644 --- a/docker/README.rst +++ b/docker/README.rst @@ -6,10 +6,21 @@ OST Docker For many docker installations it is required to run docker commands as root. As this depends on set up, we skip the ``sudo`` in all commands. +Obtain image from the OST registry +---------------------------------- + +OST has its own [container registry](https://git.scicore.unibas.ch/schwede/openstructure/container_registry) inside GitLab. There we try to keep one image for the latest stable version of OST. You can import it by + +.. code-block:: bash + + docker pull registry.scicore.unibas.ch/schwede/openstructure:<TAG> + +and just start using it without the overhead to build it yourself. + + Build Docker image ------------------ - In order to build OST image: .. code-block:: bash diff --git a/modules/doc/install.rst b/modules/doc/install.rst index 72e4e26e3..37af4de49 100644 --- a/modules/doc/install.rst +++ b/modules/doc/install.rst @@ -8,8 +8,10 @@ For a simple and portable way to use OpenStructure we recommend using a container solution. We provide recipes to build images for `Docker <https://www.docker.com/>`_ and `Singularity <https://sylabs.io/singularity/>`_. -The latest recipes and instructions can be found on our GitLab site -(`Docker instructions`_ and `Singularity instructions`_). +The latest recipes and instructions can be found on our +`GitLab site <https://git.scicore.unibas.ch/schwede/openstructure/>`_, including +a link to OpenStructure's own `GitLab Docker registry <https://git.scicore.unibas.ch/schwede/openstructure/container_registry>`_ (`Docker instructions`_ and +`Singularity instructions`_). If you wish to compile OpenStructure outside of a container, you need to follow the steps which we describe in detail below. In essence, these steps are: -- GitLab