Skip to content
Snippets Groups Projects
Commit 9df7f137 authored by OZGCloud's avatar OZGCloud
Browse files

README aktualisiert

parent bd98748c
No related branches found
No related tags found
No related merge requests found
...@@ -2,9 +2,9 @@ This repository is for the OZG application room. ...@@ -2,9 +2,9 @@ This repository is for the OZG application room.
# Getting Started # Getting Started
### Reference Documentation ### Weitere Dokumentation
For further reference, please consider the following sections: Weitere Informationen finden Sie unter folgenden Links:
* [Spring Boot Gradle Plugin Reference Guide](https://docs.spring.io/spring-boot/docs/current/gradle-plugin/reference/htmlsingle/) * [Spring Boot Gradle Plugin Reference Guide](https://docs.spring.io/spring-boot/docs/current/gradle-plugin/reference/htmlsingle/)
* [Create an OCI image](https://docs.spring.io/spring-boot/docs/3.1.3/maven-plugin/reference/html/#build-image) * [Create an OCI image](https://docs.spring.io/spring-boot/docs/3.1.3/maven-plugin/reference/html/#build-image)
...@@ -17,7 +17,7 @@ For further reference, please consider the following sections: ...@@ -17,7 +17,7 @@ For further reference, please consider the following sections:
### Guides ### Guides
The following guides illustrate how to use some features: Mehr informationen zu den verwendeten Feature sind hier:
* [Building an Application with Spring Boot](https://spring.io/guides/gs/spring-boot/) * [Building an Application with Spring Boot](https://spring.io/guides/gs/spring-boot/)
* [Building a RESTful Web Service with Spring Boot Actuator](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#actuator) * [Building a RESTful Web Service with Spring Boot Actuator](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#actuator)
...@@ -27,40 +27,38 @@ The following guides illustrate how to use some features: ...@@ -27,40 +27,38 @@ The following guides illustrate how to use some features:
* [Keycloak Configuration](https://git.ozg-sh.de/ozgcloud-app/antragsraum-server/src/branch/dev/documentation/KeycloakSetup.md) * [Keycloak Configuration](https://git.ozg-sh.de/ozgcloud-app/antragsraum-server/src/branch/dev/documentation/KeycloakSetup.md)
* [BayernId Implementation and configuration](documentation/BayernIdLogin.md) * [BayernId Implementation and configuration](documentation/BayernIdLogin.md)
Healthchecks are available at: Healthchecks sind hier:
* http://localhost:8081/actuator/health * http://localhost:8081/actuator/health
* http://localhost:8081/actuator/info * http://localhost:8081/actuator/info
The info endpoint also contains the build information. Der Info Endpoint hat auch die build Informationen.
REST Interface Dokumentation is available by using OpenAPI V3 Das REST Interface ist mit OpenAPI V3 dokumentiert und kann auf der Swagger-Seite angesehen werden
When the application is running you can access the swagger page at
http://localhost:8080/swagger-ui/index.html http://localhost:8080/swagger-ui/index.html
## Run the application ## Anwendung starten
There are three profiles: Es gibt drei Profile:
* default - The profile for production environment * default - Das Profil für die Produktionsumgebung
* local - The profile for dev stages with connection to the info-manager * local - Das Profil für die Entwicklung
* lasttest - The profile for running lasttests * lasttest - Das Profil um Lasttests auszuführen.
You can start the application by command line by using Man kann die Anwendung über die Kommandozeile starten
``` ```
./mvnw spring-boot:run -Dspring-boot.run.profiles=local ./mvnw spring-boot:run -Dspring-boot.run.profiles=local
``` ```
To change the local port of the management api you can use Um den Port der Management api zu ändern, kann man den Befehl verwenden
``` ```
./mvnw spring-boot:run -Dmanagement.server.port=8081 ./mvnw spring-boot:run -Dmanagement.server.port=8081
``` ```
or with docker compose by using something like: oder man verwenden docker compose
``` ```
mongodb: mongodb:
...@@ -126,7 +124,6 @@ or with docker compose by using something like: ...@@ -126,7 +124,6 @@ or with docker compose by using something like:
- ozgcloud_jwt_secret="346593nbdgb8e74t6vw477q34bg83456§$$%/&Hgvt78hlsjdgfw8äy.skeiw44tz asjkdefa wlfugwegw" - ozgcloud_jwt_secret="346593nbdgb8e74t6vw477q34bg83456§$$%/&Hgvt78hlsjdgfw8äy.skeiw44tz asjkdefa wlfugwegw"
- ozgcloud_antragsraum_bayernid_redirect-url=http://localhost:8082 - ozgcloud_antragsraum_bayernid_redirect-url=http://localhost:8082
- clamav_scanUrl=http://clamav-api:3000/api/v1/scan - clamav_scanUrl=http://clamav-api:3000/api/v1/scan
- logging_level_net_devh_boot_grpc=INFO
- logging_level_org_springframework_web=INFO - logging_level_org_springframework_web=INFO
- SPRING_SECURITY_SAML2_RELYINGPARTY_REGISTRATION_BAYERNID_ENTITY-ID=https://sso.load.by.ozg-cloud.de/realms/by-antragsraum-idp - SPRING_SECURITY_SAML2_RELYINGPARTY_REGISTRATION_BAYERNID_ENTITY-ID=https://sso.load.by.ozg-cloud.de/realms/by-antragsraum-idp
- SPRING_SECURITY_SAML2_RELYINGPARTY_REGISTRATION_BAYERNID_ASSERTINGPARTY_METADATA-URI=https://sso.dev.by.ozg-cloud.de/realms/by-antragsraum-idp/protocol/saml/descriptor - SPRING_SECURITY_SAML2_RELYINGPARTY_REGISTRATION_BAYERNID_ASSERTINGPARTY_METADATA-URI=https://sso.dev.by.ozg-cloud.de/realms/by-antragsraum-idp/protocol/saml/descriptor
...@@ -144,7 +141,7 @@ or with docker compose by using something like: ...@@ -144,7 +141,7 @@ or with docker compose by using something like:
target: /idp.key target: /idp.key
read_only: true read_only: true
antragraum-proxy: antragraum-proxy:
image: 'docker.ozg-sh.de/antragsraum-proxy:v1.0.0-release' image: 'docker.ozg-sh.de/antragsraum-proxy:snapshot-latest'
ports: ports:
- 8383:8082 - 8383:8082
environment: environment:
...@@ -161,9 +158,9 @@ or with docker compose by using something like: ...@@ -161,9 +158,9 @@ or with docker compose by using something like:
memory: 20M memory: 20M
``` ```
## Setting ## Einstellungen
Important settings Wichtige Einstellungen
``` ```
ozgcloud: ozgcloud:
...@@ -192,36 +189,33 @@ ozgcloud: ...@@ -192,36 +189,33 @@ ozgcloud:
- "http://localhost:8082" - "http://localhost:8082"
``` ```
The setting regarding the BayernId configuration are documented Die Einstellung für das BayernId Login sind hier beschrieben
here [BayernId Implementation and configuration](documentation/BayernIdLogin.md)
[BayernId Implementation and configuration](documentation/BayernIdLogin.md)
On dev a Keycloak is used als replacement for the BayernId. For the setup of the Keycloak and the test users configured Auf dev wird Keycloak als ersatz für BayernId verwendet. Das Setup ist hier beschrieben
see
here [Keycloak Configuration](https://git.ozg-sh.de/ozgcloud-app/antragsraum-server/src/branch/dev/documentation/KeycloakSetup.md)
Note: [Keycloak Configuration](https://git.ozg-sh.de/ozgcloud-app/antragsraum-server/src/branch/dev/documentation/KeycloakSetup.md)
The InfoManager needs have the same value for the Jwt secret configured, so the InfoManager can verify the Tokens send
in the gRPC metadata JWT_TOKEN field. Must be at least 256 bit long
## Useful Tools ## Useful Tools
### curl ### curl
A commandline too to perform http requests. Ist eine Komandozeilenanwendung um http requests zu machen.
Examples: Beispiele:
Upload a file to the Antragsraum backend. Upload einer Datei
Where 6358fd0bee7a051389cdd787 is the id of the Vorgang
and 6358fd4146811d04010f44d1 is the id of the Nachricht 6358fd0bee7a051389cdd787 ist die Id des Vorgangs und 6358fd4146811d04010f44d1 ist die Id der Nachricht.
``` ```
curl -F file=@</path/to/the/file/file_name> http://localhost:8080/api/file/6358fd0bee7a051389cdd787/6358fd4146811d04010f44d1 -v curl -F file=@</path/to/the/file/file_name> http://localhost:8080/api/file/6358fd0bee7a051389cdd787/6358fd4146811d04010f44d1 -v
``` ```
### Ports used ### Verwendetet Ports
#### Local Dev environment: #### Lokale Dev Umgebung:
| Port | Application/Service | Addresses | | Port | Application/Service | Addresses |
|-------|---------------------------|--------------------------------| |-------|---------------------------|--------------------------------|
...@@ -234,13 +228,10 @@ curl -F file=@</path/to/the/file/file_name> http://localhost:8080/api/file/6358 ...@@ -234,13 +228,10 @@ curl -F file=@</path/to/the/file/file_name> http://localhost:8080/api/file/6358
| 8381 | Infomanager Proxy Api | http://localhost:8381/ | | 8381 | Infomanager Proxy Api | http://localhost:8381/ |
| 27027 | MongoDB | | | 27027 | MongoDB | |
Only the SAML Login against the Keycloak can be used for local development. Für die lokale Entwicklung kann nur das SAML Login vom Keycloak verwendet werden.
For local development there are stubs of the VorgangManager APIs available.
To enable it the *local* profile must be used. Dafür muss das *local* verwendet werden.
This uses the settings defined in the application-local.yml file. Dazu müssen diese Werte in der application-local.yml stehen:
Within this file following must be configured:
``` ```
spring: spring:
...@@ -264,23 +255,23 @@ spring: ...@@ -264,23 +255,23 @@ spring:
metadata-uri: "https://sso.dev.by.ozg-cloud.de/realms/by-antragsraum-idp/protocol/saml/descriptor" metadata-uri: "https://sso.dev.by.ozg-cloud.de/realms/by-antragsraum-idp/protocol/saml/descriptor"
``` ```
Then you can use the user 'test' with the password 'test' to login. Dann kann man die in Keycloak vorhandenen Benutzer verwenden.
Whe using the local Profile the redirect url in the antragsraum-client must be configured to http://localhost:8080/login Um das lokale Profil zu verwenden, muss die redirect url im Antragsraum-client auf http://localhost:8080/login gesetzt
werden.
### More Information ### Weitere Informationen
* [BayernId Implementation and configuration](documentation/BayernIdLogin.md) * [BayernId Implementation and configuration](documentation/BayernIdLogin.md)
* [Keycloak Configuration](https://git.ozg-sh.de/ozgcloud-app/antragsraum-server/src/branch/dev/documentation/KeycloakSetup.md) * [Keycloak Configuration](https://git.ozg-sh.de/ozgcloud-app/antragsraum-server/src/branch/dev/documentation/KeycloakSetup.md)
### Other Tools: ### Andere Tools:
#### mujina idp #### mujina idp
Mujina is an SAML2 IdentityProvider for testing and if fully configurable using a REST Interface. In this project the Mujina ist ein SAML2 IdentityProvider zum testing und kann über ein REST Interface konfiguriert werden.
mujina IDP is used for the load tests. Encryption of assertions is not supported.
To use build the container and to use it following steps are necessary: Um Mujina als Docker Container zu verwenden, muss dieser lokal gebaut werden.
Clone the repository https://github.com/OpenConext/Mujina Clone the repository https://github.com/OpenConext/Mujina
build the container using maven in the directory mujina-idp. mvn spring-boot:build-image -DskipTests build the container using maven in the directory mujina-idp. mvn spring-boot:build-image -DskipTests
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment