governikus/eidas-middleware

This work is provided under the terms of the EUPL 1.2. The terms of the LICENSE.txt do only apply for the official release of the eIDAS Middleware, which is provided by Governikus GmbH & Co. KG on behalf of the German Federal Government.

Governikus eIDAS Middleware

This repository contains the source code of the German eIDAS middleware.

Releases

With every release, the source code of our internal repository will be exported into this repository. The signed release artifacts will be released on github as well.

Build

Building the java sources

We are using maven to build and test the software.

To build the software, execute the following command:

$ mvn clean install

You can find the compiled JARs in the target/ directory of each module.

Building the documentation

The source for the documentation can be found in the doc folder.

To build a pdf file, sphinx is needed. Please see the sphinx documentation on how to install sphinx on your system.

To create the pdf file, issue the following commands:

$ (cd doc && make clean latexpdf)

The created pdf document can be found at doc/_build/latex/eIDASMiddleware.pdf.

Documentation

The user documentation for each release is available in the release artifacts.

Contributing

Please see CONTRIBUTING.md for more information on how to submit pull requests.

License

Copyright © 2020 Governikus KG

This work is provided under the terms of the EUPL 1.2. The terms of the LICENSE.txt do only apply for the official release of the eIDAS Middleware, which is provided by Governikus GmbH & Co. KG on behalf of the German Federal Government.

The overview of the used third party dependecies and their licenses is available in the release documents.