-
Notifications
You must be signed in to change notification settings - Fork 12
Expand file tree
/
Copy pathvalues.yaml
More file actions
1896 lines (1632 loc) · 58.8 KB
/
values.yaml
File metadata and controls
1896 lines (1632 loc) · 58.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# =============================================================================
# BunkerWeb Helm Chart Values
# =============================================================================
# This file contains all configurable values for the BunkerWeb Helm chart.
# For more information about BunkerWeb configuration, visit:
# https://docs.bunkerweb.io/
# =============================================================================
# GLOBAL CONFIGURATION
# =============================================================================
# These settings apply to all components unless overridden
# Global image pull secrets for private registries
# Example: imagePullSecrets: [{"name": "myregistry-secret"}]
imagePullSecrets: []
# Override the chart name (default: chart name)
nameOverride: ""
# Override the namespace (default: release namespace)
namespaceOverride: ""
# Override the full resource name (default: release-chart)
fullnameOverride: ""
# Node selector for all pods (can be overridden per component)
# Example: nodeSelector: {"kubernetes.io/arch": "amd64"}
nodeSelector: {}
# Tolerations for all pods (can be overridden per component)
# Example: tolerations: [{"key": "node-role", "operator": "Equal", "value": "master", "effect": "NoSchedule"}]
tolerations: []
# Topology spread constraints for better pod distribution
# Example: topologySpreadConstraints: [{"maxSkew": 1, "topologyKey": "kubernetes.io/hostname", "whenUnsatisfiable": "DoNotSchedule"}]
topologySpreadConstraints: []
# =============================================================================
# BUNKERWEB CORE SETTINGS
# =============================================================================
# Configuration for BunkerWeb behavior in Kubernetes environment
settings:
# ----- SECRET MANAGEMENT -----
# Specify the name of an existing secret containing sensitive parameters.
# When using this, the following keys should be present:
# - database-uri : Database connection string
# - redis-username : Redis username (if authentication enabled)
# - redis-password : Redis password
# - admin-username : UI admin username
# - admin-password : UI admin password
# - flask-secret : Flask session secret
# - totp-secrets : TOTP secrets for 2FA
# - mariadb-user : MariaDB username
# - mariadb-password : MariaDB password
# - pro-license-key : BunkerWeb Pro license key
# - api-token : API Bearer token
# - api-username : API username, also require api-password
# - api-password : API password, also require api-username
existingSecret: ""
# ----- KUBERNETES INTEGRATION -----
kubernetes:
# Comma-separated list of namespaces to monitor for Ingress resources
# Empty string means all namespaces (requires cluster-wide permissions)
# Example: "default,production,staging"
namespaces: ""
# Ingress class name that BunkerWeb will handle
# Must match the IngressClass resource name
ingressClass: ""
# Kubernetes cluster domain name for service discovery
domainName: "cluster.local"
# Annotations to be ignored by bunkerweb-controller when multiple ingress controllers (comma-separated)
ignoreAnnotations: ""
# ----- GENERAL CONFIGURATION -----
misc:
# Database connection URI (auto-generated if using internal MariaDB)
# Format: mysql+pymysql://user:password@host:port/database
databaseUri: ""
# DNS resolvers for BunkerWeb (space-separated)
# Default uses CoreDNS service in kube-system namespace
dnsResolvers: "coredns.kube-system.svc.cluster.local"
# IP ranges allowed to access BunkerWeb API (space-separated CIDR blocks)
# Includes common Kubernetes and private network ranges
apiWhitelistIp: "127.0.0.0/8 10.0.0.0/8 172.16.0.0/12 192.168.0.0/16"
# ----- REDIS CONFIGURATION -----
redis:
# Enable Redis for caching and persistence
# Recommended for production environments
useRedis: "yes"
# Redis hostname (auto-configured if using internal Redis)
redisHost: ""
# Redis authentication (leave empty if not using auth)
redisUsername: ""
redisPassword: ""
# ----- WEB UI CONFIGURATION -----
ui:
# Enable the setup wizard on first launch
wizard: true
# if using new Gateway API integration instead of ingress resources
# HTTP routes configuration for UI access
httpRoutes:
# Enable HTTP routes for UI access
enabled: false
# GatewayClass name to use
gatewayClassName: ""
# Domain name for UI access
# Example: "bunkerweb-ui.example.com"
serverName: ""
# Path for UI access
serverPath: "/"
# Additional annotations for the httpRoute resource
# Example: {"cert-manager.io/cluster-issuer": "letsencrypt-prod"}
extraAnnotations: {}
# Secret name containing TLS certificate
# Leave empty to disable HTTPS
tlsSecretName: ""
# Ingress configuration for UI access
ingress:
# Set to true to create an Ingress resource for the UI
enabled: false
# IngressClass name to use
ingressClassName: ""
# Domain name for UI access
# Example: "bunkerweb-ui.example.com"
serverName: ""
# Path for UI access (usually "/")
serverPath: "/"
# Additional annotations for the Ingress resource
# Example: {"cert-manager.io/cluster-issuer": "letsencrypt-prod"}
extraAnnotations: {}
# Secret name containing TLS certificate
# Leave empty to disable HTTPS
tlsSecretName: ""
# UI authentication settings
adminUsername: ""
adminPassword: ""
# Override admin credentials on startup
# Set to "yes" to reset admin credentials to the values above
overrideAdminCreds: "no"
# Flask session secret (auto-generated if empty)
flaskSecret: ""
# TOTP secrets for two-factor authentication
totpSecrets: ""
# Maximum upload size in bytes (default: 50MB)
maxContentLength: ""
# Max requests before Gunicorn worker restart
maxRequests: ""
api:
# Authentication settings
# https://docs.bunkerweb.io/latest/api/#authentication
# Choose at least one method of authentication
# API Bearer Token
useBearerToken:
# If enable, it will use settings.existingSecret
fromExistingSecret: false
# If not using existingSecret, set the token here
token: ""
# Username and Password
useUserPass:
# If enable, it will use settings.existingSecret
fromExistingSecret: false
# If not using existingSecret, set the credentials here
apiUsername: ""
apiPassword: ""
# OR/AND ConfigMap name that includes ACL based JSON File
# https://docs.bunkerweb.io/latest/api/#permissions-acl
apiAclBootstrapFile: ""
# API Configuration
# https://docs.bunkerweb.io/latest/api/#configuration
# Root path for the API
rootPath: ""
# URL for API documentation, set to an empty value to disable
docsUrl: "/docs"
# URL for ReDoc API documentation, set to an empty value to disable
redocUrl: "/redoc"
# URL for OpenAPI specification, set to an empty value to disable
openApiUrl: "/openapi.json"
# Max requests before Gunicorn worker restart
maxRequests: ""
# Forwarded allow IPs for correct client IP detection
forwardedAllowIps: "*"
# Whitelist configuration for API access
whitelist:
# Enable API whitelist functionality
enabled: true
# space-separated list of IPs/CIDR allowed to access the API
whitelistIps: "10.0.0.0/8 127.0.0.1/32 127.0.0.0/8"
# Rate limiting configuration for API access
# https://docs.bunkerweb.io/latest/api/#rate-limiting
rateLimit:
# Enable request rate limiting
enabled: false
# Strategy: "fixed-window" or "moving-window" or "sliding-window"
# https://limits.readthedocs.io/en/stable/strategies.html
strategy: "fixed-window"
# Rate limit per period,
# Supported formats: "[10/seconde]", "[100/minute]", "[1000/day]"
# https://limits.readthedocs.io/en/stable/quickstart.html#rate-limit-string-notation
defaults: ["100/minute"]
# if using new Gateway API integration instead of ingress resources
# HTTP routes configuration for API access
httpRoutes:
# Enable HTTP routes for API access
enabled: false
# GatewayClass name to use
gatewayClassName: ""
# Domain name for API access
# Example: "bunkerweb-api.example.com"
serverName: ""
# Path for API access
serverPath: "/admin"
# Additional annotations for the Ingress resource
# Example: {"cert-manager.io/cluster-issuer": "letsencrypt-prod"}
extraAnnotations: {}
# Secret name containing TLS certificate
# Leave empty to disable HTTPS
tlsSecretName: ""
# Ingress configuration for API access
ingress:
# Set to true to create an Ingress resource for the API
enabled: false
# IngressClass name to use
ingressClassName: ""
# Domain name for API access
# Example: "bunkerweb-api.example.com"
serverName: ""
# Path for API access (usually "/")
serverPath: "/"
# Additional annotations for the Ingress resource
# Example: {"cert-manager.io/cluster-issuer": "letsencrypt-prod"}
extraAnnotations: {}
# Secret name containing TLS certificate
# Leave empty to disable HTTPS
tlsSecretName: ""
# =============================================================================
# SERVICE CONFIGURATION
# =============================================================================
# External service for BunkerWeb (LoadBalancer/NodePort)
service:
# Enable external service creation
enabled: true
# Service type: LoadBalancer, NodePort, or ClusterIP
# LoadBalancer: Exposes service externally using cloud provider's load balancer
# NodePort: Exposes service on each node's IP at a static port
# ClusterIP: Only accessible within the cluster
type: LoadBalancer
# Set defined NodePorts if using Service type NodePort, if not set, random ports will be assigned
# nodePortHttp: 30080
# nodePortHttps: 30443
# External traffic policy: Local or Cluster
# Local: Preserves client IP but may cause uneven distribution
# Cluster: Better distribution but loses client IP
externalTrafficPolicy: Local
# Additional service annotations
# Example: {"service.beta.kubernetes.io/aws-load-balancer-type": "nlb"}
annotations: {}
# =============================================================================
# BUNKERWEB COMPONENT
# =============================================================================
# Main reverse proxy and WAF component
bunkerweb:
# Enable BunkerWeb component, should always be true except for sidecar use cases
enabled: true
# Deployment type: "DaemonSet" or "Deployment" or "StatefulSet"
# DaemonSet: Runs one pod per node (recommended for ingress)
# Deployment: Runs specified number of replicas
# StatefulSet: For stable network IDs and storage (not typical for ingress)
kind: Deployment
# Pod annotations for Kubernetes integration (required)
# This enables BunkerWeb to be managed by the controller
enableInstance: true
# Use host ports for direct traffic (only for DaemonSet)
# Allows binding to ports 80/443 on each node
hostPorts: true
# Number of replicas (for Deployment & StatefulSet kind)
# Minimum 2 for high availability and PodDisruptionBudget
replicas: 1
# Container image configuration
# Also available at ghcr.io/bunkerity/bunkerweb
repository: docker.io/bunkerity/bunkerweb
tag: 1.6.9
pullPolicy: IfNotPresent
# Resource requests and limits
# RECOMMENDED: Uncomment and adjust for production
# resources:
# requests:
# cpu: "2000m"
# memory: "4096Mi"
# limits:
# cpu: "4000m"
# memory: "8192Mi"
# Horizontal Pod Autoscaler (HPA) configuration
# Make sure to set resources.requests for CPU and/or memory
hpa:
# Enable HPA for bunkerweb component
enabled: false
# Target kind for scaling (Deployment or StatefulSet)
targetKind: "Deployment"
# Optional name override for the target resource
# If empty, uses the default release fullname
nameOverride: ""
# Minimum number of replicas (ignored for DaemonSet)
minReplicas: 2
# Maximum number of replicas
maxReplicas: 10
# CPU-based scaling configuration
cpu:
enabled: true
targetAverageUtilization: 90
# Memory-based scaling configuration
memory:
enabled: false
targetAverageUtilization: 90
# HPA behavior configuration
# Controls the scaling speed and stabilization
behavior:
scaleUp:
# Stabilization before scale up: waits for constant threshold crossing
stabilizationWindowSeconds: 60
policies:
# Policy 1: Max +100% of current replicas per minute
- type: Percent
value: 100
periodSeconds: 60
# Policy 2: Max +2 pods per minute
- type: Pods
value: 2
periodSeconds: 60
# Takes the MOST CONSERVATIVE of the 2 policies
selectPolicy: Min
scaleDown:
# Stabilization before scale down: waits for under-utilization
stabilizationWindowSeconds: 300
policies:
# Policy 1: Max -50% of current replicas per minute
- type: Percent
value: 50
periodSeconds: 60
# Policy 2: Max -1 pod per minute
- type: Pods
value: 1
periodSeconds: 60
# Takes the MOST CONSERVATIVE of the 2 policies
selectPolicy: Min
# Internal service configuration (for inter-pod communication)
service:
# Use headless service (clusterIP: None) for service discovery
# If false, creates a ClusterIP service with BWAPI port 5000
headless: true
# Image pull secrets (overrides global setting)
imagePullSecrets: []
# Node selector (overrides global setting)
nodeSelector: {}
# Tolerations (overrides global setting)
tolerations: []
# Pod affinity rules
affinity: {}
# Anti-affinity preset: "soft" or "hard"
# soft: Prefers not to schedule pods on same node
# hard: Never schedules pods on same node
podAntiAffinityPreset: "soft"
# Additional pod annotations
podAnnotations: {}
# Additional pod labels
podLabels: {}
# Security context for BunkerWeb container
securityContext:
runAsUser: 101
runAsGroup: 101
allowPrivilegeEscalation: false
capabilities:
drop:
- ALL
# Additional environment variables
# Example: extraEnvs: [{"name": "DEBUG", "value": "true"}]
extraEnvs: []
# Liveness probe configuration
livenessProbe:
exec:
command:
- /usr/share/bunkerweb/helpers/healthcheck.sh
initialDelaySeconds: 30
periodSeconds: 5
timeoutSeconds: 1
failureThreshold: 3
# Readiness probe configuration
readinessProbe:
exec:
command:
- /usr/share/bunkerweb/helpers/healthcheck.sh
- ok
initialDelaySeconds: 30
periodSeconds: 1
timeoutSeconds: 1
failureThreshold: 3
# Custom volumes configuration
# Allows mounting additional volumes to the BunkerWeb container
volumes: []
# Example:
# volumes:
# - name: shared-data
# persistentVolumeClaim:
# claimName: shared-pvc
# Custom volume mounts configuration
# Defines where to mount the custom volumes in the container
volumeMounts: []
# Example:
# volumeMounts:
# - name: shared-data
# mountPath: /var/lib/bunkerweb/shared
## PodDisruptionBudget for default backend
## bunkerweb Pod Disruption Budget configuration
## ref: https://kubernetes.io/docs/tasks/run-application/configure-pdb/
##
pdb:
# Enable creation of Pod Disruption Budget
# Make sure you have at least 2 replicas if enabled
create: true
# Minimum number/percentage of pods that must remain available
# Example: minAvailable: 1 or minAvailable: "50%"
minAvailable: ""
# Maximum number/percentage of pods that can be unavailable
# Example: maxUnavailable: 1 or maxUnavailable: "25%"
maxUnavailable: ""
# =============================================================================
# SCHEDULER COMPONENT
# =============================================================================
# Manages BunkerWeb configuration and coordination
scheduler:
# Container image configuration
# Also available at ghcr.io/bunkerity/bunkerweb-scheduler
repository: docker.io/bunkerity/bunkerweb-scheduler
tag: 1.6.9
pullPolicy: IfNotPresent
# Image pull secrets (overrides global setting)
imagePullSecrets: []
# Node selector (overrides global setting)
nodeSelector: {}
# Tolerations (overrides global setting)
tolerations: []
# Resource requests and limits
# RECOMMENDED: Uncomment and adjust for production
# resources:
# requests:
# cpu: "250m"
# memory: "256Mi"
# limits:
# cpu: "500m"
# memory: "512Mi"
# Additional pod annotations
podAnnotations: {}
# Additional pod labels
podLabels: {}
# Security context for scheduler container
securityContext:
runAsUser: 101
runAsGroup: 101
allowPrivilegeEscalation: false
capabilities:
drop:
- ALL
# PRO Features configuration
# BunkerWeb PRO license key for advanced features
proLicenseKey: ""
# Enable Prometheus metrics exporter and creates a service for it
# Requires BunkerWeb PRO license
usePrometheusExporter: false
# ==================================================== #
# BunkerWeb feature configuration
# These settings control the behavior of BunkerWeb security features
# These features will be applied by default on any new services, but could be overwritten on a per service basis
# For more details, visit: https://docs.bunkerweb.io/latest/features/
features:
# =============================================================================
# GLOBAL SETTINGS
# =============================================================================
global:
# Security mode: "detect" for monitoring only, "block" for active protection
securityMode: ""
# Default server protection
disableDefaultServer: ""
disableDefaultServerStrictSni: ""
# =============================================================================
# NGINX TIMEOUTS
# =============================================================================
timeouts:
# Timeout for reading client request body
clientBodyTimeout: ""
# Timeout for reading client request header
clientHeaderTimeout: ""
# Timeout for keep-alive client connections
keepaliveTimeout: ""
# Timeout for transmitting response to client
sendTimeout: ""
# =============================================================================
# DATABASE CONNECTION POOL
# =============================================================================
databasePool:
# Number of connections in the pool
databasePoolSize: ""
# Max connections above pool size
databasePoolMaxOverflow: ""
# Seconds to wait for a connection from pool
databasePoolTimeout: ""
# Seconds after which connection is recycled (-1 to disable)
databasePoolRecycle: ""
# Test connections for liveness on checkout
databasePoolPrePing: ""
# How to reset connection on return (auto/none/rollback)
databasePoolResetOnReturn: ""
# Max seconds to wait for database on startup
databaseRetryTimeout: ""
# Retry attempts for transient errors
databaseRequestRetryAttempts: ""
# Delay between retry attempts (seconds)
databaseRequestRetryDelay: ""
# =============================================================================
# MODSECURITY WAF
# =============================================================================
modsecurity:
# Enable ModSecurity Web Application Firewall
useModsecurity: ""
# Enable OWASP Core Rule Set
useModsecurityCrs: ""
# CRS version: "3", "4", or "nightly"
modsecurityCrsVersion: ""
# Rule engine: "On", "DetectionOnly", or "Off"
modsecuritySecRuleEngine: ""
# Enable CRS plugins for enhanced protection
useModsecurityCrsPlugins: ""
# List of CRS plugins to install (space-separated)
modsecurityCrsPlugins: ""
# =============================================================================
# ANTIBOT PROTECTION
# =============================================================================
antibot:
# Antibot challenge type: "no", "cookie", "javascript", "captcha", "recaptcha", "hcaptcha", "turnstile", "mcaptcha"
useAntibot: ""
# Challenge URI (must be unique and not used by your application)
antibotUri: ""
# Time limit to complete challenge (seconds)
antibotTimeResolve: ""
# Challenge validity duration (seconds)
antibotTimeValid: ""
# IPs to bypass antibot challenges (space-separated)
antibotIgnoreIp: ""
# URIs to bypass antibot challenges (regex patterns, space-separated)
antibotIgnoreUri: ""
# Use classic reCAPTCHA instead of newer version
antibotRecaptchaClassic: ""
# =============================================================================
# RATE LIMITING
# =============================================================================
rateLimit:
# Enable request rate limiting
useLimitReq: ""
# Rate limit (e.g., "2r/s", "60r/m")
limitReqRate: ""
# URL pattern to apply rate limiting
limitReqUrl: ""
# Enable connection limiting
useLimitConn: ""
# Max HTTP/1.1 connections per IP
limitConnMaxHttp1: ""
# Max HTTP/2 connections per IP
limitConnMaxHttp2: ""
# Max HTTP/3 connections per IP
limitConnMaxHttp3: ""
# =============================================================================
# BLACKLIST/WHITELIST
# =============================================================================
blacklist:
# Enable blacklist functionality
useBlacklist: ""
# Community blacklists to use
blacklistCommunityLists: ""
# Manual IP blacklist (space-separated)
blacklistIp: ""
# Blacklist URLs for automatic updates
blacklistIpUrls: ""
whitelist:
# Enable whitelist functionality
useWhitelist: ""
# Manual IP whitelist (space-separated CIDR)
whitelistIp: ""
# Whitelist URLs for automatic updates
whitelistIpUrls: ""
# =============================================================================
# COUNTRY BLOCKING
# =============================================================================
geoBlocking:
# Allowed countries (ISO 3166-1 alpha-2 codes or group tokens like @EU, @G7, @FIVE_EYES, space-separated)
whitelistCountry: ""
# Blocked countries (ISO 3166-1 alpha-2 codes or group tokens like @EU, @G7, @FIVE_EYES, space-separated)
blacklistCountry: ""
# =============================================================================
# BAD BEHAVIOR DETECTION
# =============================================================================
badBehavior:
# Enable bad behavior detection
useBadBehavior: ""
# HTTP status codes considered "bad" (space-separated)
badBehaviorStatusCodes: ""
# Threshold before banning IP
badBehaviorThreshold: ""
# Time window for counting bad requests (seconds)
badBehaviorCountTime: ""
# Ban duration (seconds, 0 = permanent)
badBehaviorBanTime: ""
# =============================================================================
# SSL/TLS CONFIGURATION
# =============================================================================
ssl:
# Enable HTTPS listening
listenHttps: ""
# SSL protocols to support
sslProtocols: ""
# Cipher security level: "old", "intermediate", "modern"
sslCiphersLevel: ""
# Auto-redirect HTTP to HTTPS
autoRedirectHttpToHttps: ""
# Let's Encrypt configuration
letsEncrypt:
# Enable automatic Let's Encrypt certificates
autoLetsEncrypt: ""
# Email for Let's Encrypt notifications
emailLetsEncrypt: ""
# Challenge type: "http" or "dns"
letsEncryptChallenge: ""
# DNS provider for DNS challenges
letsEncryptDnsProvider: ""
# Enable wildcard certificates (DNS challenges only)
useLetsEncryptWildcard: ""
# Certificate authority server: "letsencrypt" or "zerossl"
letsEncryptServer: ""
# Certificate profile: "classic" or other profiles
letsEncryptProfile: ""
# Custom certificate profile (overrides letsEncryptProfile)
letsEncryptCustomProfile: ""
# ZeroSSL API key (optional, falls back to email)
letsEncryptZerosslApiKey: ""
# ZeroSSL API connection timeout (seconds)
letsEncryptZerosslApiConnectTimeout: ""
# ZeroSSL API max time (seconds)
letsEncryptZerosslApiMaxTime: ""
# ZeroSSL API retry count
letsEncryptZerosslApiRetry: ""
# ZeroSSL API retry delay (seconds)
letsEncryptZerosslApiRetryDelay: ""
# Custom SSL certificate
customSsl:
# Use custom SSL certificates
useCustomSsl: ""
# Certificate priority: "file" or "data"
customSslCertPriority: ""
# Certificate file path
customSslCert: ""
# Private key file path
customSslKey: ""
# =============================================================================
# COMPRESSION
# =============================================================================
compression:
# Enable GZIP compression
useGzip: ""
# GZIP compression level (1-9)
gzipCompLevel: ""
# Minimum response size for compression (bytes)
gzipMinLength: ""
# Enable Brotli compression
useBrotli: ""
# Brotli compression level (0-11)
brotliCompLevel: ""
# =============================================================================
# CLIENT CACHING
# =============================================================================
clientCache:
# Enable client-side caching
useClientCache: ""
# File extensions to cache (pipe-separated)
clientCacheExtensions: ""
# Cache-Control header value
clientCacheControl: ""
# Enable ETags
clientCacheEtag: ""
# =============================================================================
# REVERSE PROXY
# =============================================================================
reverseProxy:
# Enable reverse proxy functionality
useReverseProxy: ""
# Backend server URLs (multiple values supported with suffix _1, _2, etc.)
reverseProxyHost: ""
# URL paths to proxy (multiple values supported with suffix _1, _2, etc.)
reverseProxyUrl: ""
# Connection timeout
reverseProxyConnectTimeout: ""
# Send timeout
reverseProxySendTimeout: ""
# Read timeout
reverseProxyReadTimeout: ""
# =============================================================================
# GRPC REVERSE PROXY
# =============================================================================
grpc:
# Enable gRPC reverse proxy mode
useGrpc: ""
# Location URL to proxy to gRPC upstream
grpcUrl: ""
# Upstream value (e.g., grpc://app:50051 or grpcs://app:443)
grpcHost: ""
# Timeout when connecting to gRPC upstream
grpcConnectTimeout: ""
# Timeout when reading from gRPC upstream
grpcReadTimeout: ""
# Timeout when sending to gRPC upstream
grpcSendTimeout: ""
# Override Host header sent to gRPC upstream
grpcCustomHost: ""
# Headers to send to gRPC upstream (semicolon-separated)
grpcHeaders: ""
# Headers to hide from clients
grpcHideHeaders: ""
# Intercept and rewrite gRPC upstream errors
grpcInterceptErrors: ""
# Enable keepalive for gRPC upstream sockets
grpcSocketKeepalive: ""
# Enable SNI for gRPC upstream
grpcSslSni: ""
# SNI host name for gRPC upstream
grpcSslSniName: ""
# Conditions for selecting next gRPC upstream server
grpcNextUpstream: ""
# Time limit for passing request to next server
grpcNextUpstreamTimeout: ""
# Max attempts to pass request to next server
grpcNextUpstreamTries: ""
# Additional config for gRPC location block
grpcIncludes: ""
# =============================================================================
# REAL IP DETECTION
# =============================================================================
realIp:
# Enable real IP detection (behind proxy/load balancer)
useRealIp: ""
# Trusted proxy IPs (space-separated CIDR)
realIpFrom: ""
# Header containing real IP
realIpHeader: ""
# Enable recursive IP detection
realIpRecursive: ""
# Enable PROXY protocol support
useProxyProtocol: ""
# =============================================================================
# SECURITY HEADERS
# =============================================================================
headers:
# HSTS header
strictTransportSecurity: ""
# Content Security Policy
contentSecurityPolicy: ""
# CSP report-only mode
contentSecurityPolicyReportOnly: ""
# X-Frame-Options header
xFrameOptions: ""
# X-Content-Type-Options header
xContentTypeOptions: ""
# Referrer Policy
referrerPolicy: ""
# Headers to remove (space-separated)
removeHeaders: ""
# Custom headers (multiple values supported with suffix _1, _2, etc.)
customHeader: ""
# =============================================================================
# CORS CONFIGURATION
# =============================================================================
cors:
# Enable CORS
useCors: ""
# Allowed origins (regex pattern or "self" or "*")
corsAllowOrigin: ""
# Allowed HTTP methods
corsAllowMethods: ""
# Allowed headers
corsAllowHeaders: ""
# Allow credentials
corsAllowCredentials: ""
# =============================================================================
# DNSBL CHECKING
# =============================================================================
dnsbl:
# Enable DNSBL checking
useDnsbl: ""
# DNSBL servers to query (space-separated)
dnsblList: ""
# =============================================================================
# BUNKERNET THREAT INTELLIGENCE
# =============================================================================
bunkerNet:
# Enable BunkerNet threat intelligence
useBunkernet: ""
# BunkerNet API server
bunkernetServer: ""
# =============================================================================
# SESSION MANAGEMENT
# =============================================================================
sessions:
# Session secret key (leave empty to auto-generate)
sessionsSecret: ""
# Session cookie name
sessionsName: ""
# Idle timeout (seconds)
sessionsIdlingTimeout: ""
# Rolling timeout (seconds)
sessionsRollingTimeout: ""
# Absolute timeout (seconds)
sessionsAbsoluteTimeout: ""
# Check IP address consistency
sessionsCheckIp: ""
# Check User-Agent consistency
sessionsCheckUserAgent: ""
# =============================================================================
# METRICS AND MONITORING
# =============================================================================
metrics:
# Enable metrics collection
useMetrics: ""
# Memory size for metrics storage
metricsMemorySize: ""
# Max blocked requests per worker
metricsMaxBlockedRequests: ""
# Save metrics to Redis
metricsSaveToRedis: ""
# =============================================================================
# AUTH BASIC
# =============================================================================
authBasic:
# Enable HTTP Basic Authentication
useAuthBasic: ""
# Protection scope: "sitewide" or specific path
authBasicLocation: ""
# Username (multiple values supported with suffix _1, _2, etc.)
authBasicUser: ""
# Password (multiple values supported with suffix _1, _2, etc.)
authBasicPassword: ""
# Authentication prompt text
authBasicText: ""
# =============================================================================
# REDIRECTS
# =============================================================================
redirect:
# Path to redirect from
redirectFrom: ""
# Destination URL
redirectTo: ""
# Preserve request URI
redirectToRequestUri: ""
# HTTP status code for redirect
redirectToStatusCode: ""
# =============================================================================
# ERROR PAGES
# =============================================================================
errors:
# Custom error page mappings (ERROR_CODE=/path/to/file.html)
errors: ""
# HTTP error codes to intercept
interceptedErrorCodes: ""
# =============================================================================
# HTML INJECTION
# =============================================================================
htmlInjection:
# HTML to inject in <head> section
injectHead: ""
# HTML to inject before </body>
injectBody: ""
# =============================================================================
# ROBOTS.TXT
# =============================================================================
robotsTxt:
# Enable robots.txt generation
useRobotsTxt: ""
# DarkVisitors API token
robotsTxtDarkvisitorsToken: ""
# Community lists to include
robotsTxtCommunityLists: ""
# Manual robots.txt rules (multiple values supported)
robotsTxtRule: ""
# Sitemap URLs (multiple values supported)
robotsTxtSitemap: ""
# =============================================================================
# SECURITY.TXT
# =============================================================================
securityTxt:
# Enable security.txt file
useSecurityTxt: ""
# Contact information (multiple values supported)
securityTxtContact: ""
# Expiration date (ISO 8601 format)
securityTxtExpires: ""
# Security policy URL
securityTxtPolicy: ""
# =============================================================================
# CROWDSEC INTEGRATION
# =============================================================================
crowdSec: