Actuator


FlowerDocs s’appuie sur le projet Spring Boot Actuator pour fournir des web services REST aidant à monitorer et gérer une stack FlowerDocs.

Endpoints


Les endpoints disponibles sont exposés sous le path /actuator

Endpoint Description
info Informations relatives à l’application (nom et version)
health Etat de santé de l’application
env Propriétés de l’application
caches Gestion des caches utilisés
loggers Configuration des logs
logfile Téléchargement du fichier de log
status Statut de l’application (UP ou DOWN)

Ces endpoints peuvent être désactivés en ajoutant un paramètre tel que :

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

Sécurité


Par défaut, les endpoints décrits, à l’exception de status, requièrent une authentification Basic et le rôle SYSTEM_ADMIN pour chaque application exposant ces endpoints. Il est également possible de fournir un token d’authentification FlowerDocs d’un utilisateur ayant le rôle SYSTEM_ADMIN.

Le endpoint status est le seul à ne pas nécessiter d’authentification.


La sécurisation de ces endpoints peut être désactivée en ajoutant le paramètre actuator.secured=false.