pretecno/crowdsec-bouncer-traefik-plugin
3
0
Fork 0
mirror of https://github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin.git synced 2026-07-21 11:38:59 +02:00
Code Issues Packages Releases Activity

🍱 fix readme

Browse Source
This commit is contained in:
Max Lerebourg
2022-12-05 20:01:11 +01:00
parent 9406b70219
commit 7466dbec6d
1 changed files with 14 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+14 -30
View File
@@ -67,11 +67,7 @@ make run
- string - string
- default: "" - default: ""
- Crowdsec LAPI key for the bouncer : **must be unique by service**. - Crowdsec LAPI key for the bouncer : **must be unique by service**.
- CrowdsecLapiKeyFile - CrowdsecLapiTlsInsecureVerify
- string
- default: ""
- Crowdsec File path of the LAPI key for the bouncer : **must be unique by service**.
- CrowdsecLapiTLSInsecureVerify
- bool - bool
- default: false - default: false
- Disable verification of certificate presented by Crowdsec LAPI - Disable verification of certificate presented by Crowdsec LAPI
@@ -79,26 +75,14 @@ make run
- string - string
- default: "" - default: ""
- PEM-encoded Certificate Authority of the Crowdsec LAPI - PEM-encoded Certificate Authority of the Crowdsec LAPI
- CrowdsecLapiTlsCertificateAuthorityFile
- string
- default: ""
- File path of the Certificate Authority of the Crowdsec LAPI
- CrowdsecLapiTlsCertificateBouncer - CrowdsecLapiTlsCertificateBouncer
- string - string
- default: "" - default: ""
- PEM-encoded client Certificate of the Bouncer - PEM-encoded client Certificate of the Bouncer
- CrowdsecLapiTlsCertificateBouncerFile
- string
- default: ""
- File path of the client Certificate of the Bouncer
- CrowdsecLapiTlsCertificateBouncerKey - CrowdsecLapiTlsCertificateBouncerKey
- string - string
- default: "" - default: ""
- PEM-encoded client private key of the Bouncer - PEM-encoded client private key of the Bouncer
- CrowdsecLapiTlsCertificateBouncerKeyFile
- string
- default: ""
- File path of the client private key of the Bouncer
- UpdateIntervalSeconds - UpdateIntervalSeconds
- int64 - int64
- default: 60 - default: 60
@@ -107,6 +91,10 @@ make run
- int64 - int64
- default: 60 - default: 60
- Used only in `live` mode, decision duration of accepted IPs - Used only in `live` mode, decision duration of accepted IPs
- ClientTrustedIPs
- string
- default: []
- List of client IPs to trust, they will bypass any check from the bouncer or cache (useful for LAN or VPN IP)
- ForwardedHeadersTrustedIPs - ForwardedHeadersTrustedIPs
- []string - []string
- default: [] - default: []
@@ -123,10 +111,6 @@ make run
- string - string
- default: "redis:6379" - default: "redis:6379"
- hostname and port for the redis service - hostname and port for the redis service
- ClientTrustedIPs
- string
- default: []
- List of client IPs to trust, they will bypass any check from the bouncer or cache (useful for LAN or VPN IP)
### Configuration ### Configuration
@@ -208,7 +192,15 @@ http:
crowdsecLapiTLSCertificateBouncerKeyFile: /etc/traefik/crowdsec-certs/bouncer-key.pem crowdsecLapiTLSCertificateBouncerKeyFile: /etc/traefik/crowdsec-certs/bouncer-key.pem
``` ```
These are the default values for the plugin except for LapiKey.
#### Fill variable with value of file
`CrowdsecLapiTlsCertificateBouncerKey`, `CrowdsecLapiTlsCertificateBouncer`, `CrowdsecLapiTlsCertificateAuthority` and `CrowdsecLapiKey` could be provided with the content as raw or through a file path that Traefik can read.
The file variable will be used as preference if both content and file are provided for the same variable.
Format is:
- Content: VARIABLE_NAME: XXX
- FILE : VARIABLE_NAME_FILE: /path
#### Authenticate with LAPI #### Authenticate with LAPI
@@ -262,14 +254,6 @@ Set the crowdsecLapiScheme to https.
Crowdsec must be listening in HTTPS for this to work. Crowdsec must be listening in HTTPS for this to work.
Please see the tls-auth exemple or the official documentation: [https://docs.crowdsec.net/docs/local_api/tls_auth/](https://docs.crowdsec.net/docs/local_api/tls_auth/) Please see the tls-auth exemple or the official documentation: [https://docs.crowdsec.net/docs/local_api/tls_auth/](https://docs.crowdsec.net/docs/local_api/tls_auth/)
#### Fill variable with value of file
Every sensitive variable or file based can be provided with the content as raw or through a file path that Traefik can read.
The file variable will be used as preference if both content and file are provided for the same variable.
Format is:
- Content: VARIABLE_NAME: XXX
- FILE : VARIABLE_NAME_FILE: /path
#### Manually add an IP to the blocklist (for testing purposes) #### Manually add an IP to the blocklist (for testing purposes)
```bash ```bash