diff --git a/doc/source/index.rst b/doc/source/index.rst index 5915a2227a..25835d760a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -48,11 +48,12 @@ The server provides access to the 4 services: * GetCapabilities * GetVersions -The server is able to use ÖEREBlex, GeoAdmin API for gathering data. This needs to be configured and prepared -by the integrator of this package. In addition a small tool for loading legend symbols for each used WMS layer -is included. +The server is able to use several specific external api endpoints to fetch data at runtime (e.g. ÖEREBlex or GeoAdmin +API). These need to be configured and prepared by the integrator of this package. Please read the dedicated part +of documentation. -For the moment we provide an adapter to get the PDF static extract from mapfishprint. +For the moment we provide an adapter to get the PDF static extract from mapfishprint and +`xml2pdf `__. .. image:: ../images/overview.png :align: center diff --git a/doc/source/installation.rst b/doc/source/installation.rst index 4fa250d609..f79dd76956 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -26,6 +26,37 @@ In order to install and run an instance of ``pyramid_oereb``, the following requ should be able to use any spatial database, that is supported by `SQLAlchemy `__ and `GeoAlchemy 2 `__. +Above requirements might be achieved by launching locally or by docker and docker-compose to encapsulate +things. To get an idea how everything runs, we recommend to use the docker way. However the bare metal way +is described here too. + +.. _installation-docker-docker-compose: + +Docker/Docker-Compose +--------------------- + +.. note:: We assume you have a working + `docker `__/`docker-compose `__ + setup. + +.. code-block:: shell + + git clone https://github.com/openoereb/pyramid_oereb.git + +.. code-block:: shell + + # on Linux + docker-compose run --rm -u $(id -u):$(id -g) oereb-make build + +.. code-block:: shell + + # on Windows + docker-compose run --rm oereb-make build + +This will download and build the necessary docker images. + +See the + .. _installation-step: