bouncer/doc/fr/references/layers/circuitbreaker.md
William Petit c8fc143efa
All checks were successful
Cadoles/bouncer/pipeline/head This commit looks good
doc: add prometheus metrics documentation
2024-02-21 12:29:03 +01:00

1.5 KiB

Layer "Circuit Breaker"

Description

Ce layer permet de bloquer l'accès à un site (ou une section de celui ci) ciblé par un proxy.

Type

circuitbreaker

Options

authorizedCIDRs

  • Type: []string
  • Valeur par défaut: []
  • Description: Autoriser les adresses distantes contenues dans un des masques réseau (en notation "CIDR" définis à contourner la restriction d'accès.

matchURLs

  • Type: []string

  • Valeur par défaut: ["*"]

  • Description: Limiter l'action du layer à cette liste de patrons d'URLs.

    Par exemple, si vous souhaitez limiter votre restriction d'accès à l'ensemble d'une section "/blog" d'un site, vous pouvez déclarer la valeur ["*/blog*"]. Les autres URLs du site ne seront pas affectées par la restriction.

templateBlock

  • Type: string

  • Valeur par défaut: "default"

  • Description: Bloc du template HTML pour effectuer le rendu de la page indiquant la restriction d'accès.

    Voir le fichier de configuration de référence, section layers.circuitbreaker pour voir les options permettant de personnaliser le chemin du répertoire contenant les templates.

Schéma

Voir le schéma JSON.

Métriques

Aucune métrique Prometheus n'est exportée par ce layer.