diff --git a/doc/development.md b/doc/development.md index 2978b851..99a4b0bd 100644 --- a/doc/development.md +++ b/doc/development.md @@ -2,13 +2,17 @@ Frontend of the application is developed separately. -The setup requires following steps: +The setup requires the following steps: 1) configure the application according to [Setup Guide](setup.md) 2) configure `config.properties` to contain `security.sameSite=None` - This is important if you are running the application over http so + This is important if you are running the application over HTTP so web browser would not block requests to the server due to CORS policy. 3) build the backend `mvn clean package` 4) Run the created application archive (`./target/record-manager.jar`) 5) Checkout and run frontend Alternatively to step 2, a browser plugin can be used to disable CORS policy. + +## Health check + +To check that the backend is running, use path `/actuator/health` (e.g. `http://localhost:8080/record-manager/actuator/health`). diff --git a/pom.xml b/pom.xml index 8fc84ec4..7b933886 100644 --- a/pom.xml +++ b/pom.xml @@ -141,6 +141,12 @@ spring-security-test test + + + + org.springframework.boot + spring-boot-starter-actuator + diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties index efe77d59..e43a0b0e 100644 --- a/src/main/resources/application.properties +++ b/src/main/resources/application.properties @@ -1 +1,2 @@ -server.servlet.context-path=/record-manager \ No newline at end of file +server.servlet.context-path=/record-manager +management.endpoints.web.exposure.include=health \ No newline at end of file