Skip to main content
info

FlowerDocs relies on the Spring Boot Actuator project to provide REST web services to help monitor and manage a FlowerDocs stack.

Endpoints


Available endpoints are listed in the /actuator path

EndpointDescription
infoApplication information (name and version)
healthApplication health
envApplication properties
cachesManagement of used caches
loggersLog configuration
logfileDownloading the log file
statusApplication health status (UP or DOWN)

These endpoints can be disabled by adding a parameter such as:

management.endpoints.web.exposure.exclude=caches,env

Security


By default, endpoints described, excepted status, require Basic authentication and the SYSTEM_ADMIN role for each application exposing these endpoints. It is also possible to provide a FlowerDocs authentication token for a user with the SYSTEM_ADMIN role.

The status endpoint is the only one that doesn't requires authentication


The security of these endpoints can be disabled by adding the actuator.secured=false parameter.