Skip to content

Commit

Permalink
first updates
Browse files Browse the repository at this point in the history
  • Loading branch information
vvmruder committed Oct 26, 2023
1 parent da2a25b commit 71e1ff5
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 4 deletions.
9 changes: 5 additions & 4 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/Geocloud-AG/oereb_xml_pdf_service>`__.

.. image:: ../images/overview.png
:align: center
Expand Down
31 changes: 31 additions & 0 deletions doc/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://www.sqlalchemy.org/>`__ and `GeoAlchemy 2 <https://geoalchemy-2.readthedocs.io/en/latest/>`__.

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 <https://docs.docker.com/engine/install/>`__/`docker-compose <https://docs.docker.com/compose/install/>`__
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:

Expand Down

0 comments on commit 71e1ff5

Please sign in to comment.