diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 000000000..d3da33677 --- /dev/null +++ b/README.md @@ -0,0 +1,84 @@ +# MOA-ID / MOA E-ID Proxy + +## Description + +MOA-ID is an identity-provider that supports identification, authentication, and mandate processing by using different authentication methods. The MOA-ID project consists for four Sub-Projects + +- **moa-id-auth-final** is the production build of the MOA-ID IDP that can be used for production environments. +- **moa-id-auth-edu** is the IDP for education usage that includes additional sub-modules and functionality that is not part of the production build. +- **moa-id-configuration** is the configuration interface for MOA-ID IDP +- **moa-id-oa** is a simple SAML2 service-provider application for testing only + +### Building + +The application is build into a Web-application and into a set of jars that can be directly used in another application. The Web application has to be deployed into an application service, like Apache Tomcat + +The project can be build with : + +``` +mvn clean package +``` + +The resulting `war` file's can be deployed into an application server + + + +The configuration will be set by Java System-Properties: + +- MOA-ID-AUTH + - _**-Dmoa.id.configuration**_ to set the configuration for MOA-ID itself + - _**-Dmoa.spss.server.configuration**=/path/to/configuration..._ to set the configuration for the MOA-SPSS sub-module +- MOA-ID-Configuration + - _**-Dmoa.id.webconfig**_ to set the configuration for MOA-ID-Configuration itself + - _**-Duser.properties**=/path/to/configuration..._ to set the configuration file base user-database +- MOA-ID-OA + - _**-Dmoa.id.demoOA**_ to set the configuration for MOA-ID-OA itself + +### Configuration + +A default configurations for MOA-ID and MOA-SPSS is located at _/id/server/data/deploy/conf/_ + + + +## Generate a Release Package + +The full release packages for will be automatically assembled by maven build-process. Before release build, all release related information have to added into infos folder. To add release informations follow the steps outlined below. + +Add a file with release informations to: +``` +./id/readme_{version}.txt +``` + +Add, remove, or update the application description in the handbook + +``` +modify: ./id/history.txt +``` +``` +modify: ./id/server/doc/handbook/ +``` + +Generate a release package with: + + +``` +maven package +``` + +The full release package will be located add +``` +./target/* +``` + +where + +- _moa-id-4.1.6-SNAPSHOT-dist.zip_ is the production build that has to be published on JoinUp +- _moa-id-4.1.6-SNAPSHOT-dist-edu.zip_ is the eduction build for internal usage only + + + +## Changelog + +**v4.1.6** + +- |