1- # ---------------------------
2- # WebhookX configuration file
3- # ---------------------------
4-
1+ # ------------------------------------
2+ # WebhookX Configuration YAML file
3+ # ------------------------------------
54log :
6- file : /dev/stdout
7- level : info # supported values are debug, info, warn, and error.
8- format : text # supported values are " text" and " json"
5+ file : /dev/stdout # Specifies the log file.
6+ level : info # Supported values: debug, info, warn, and error.
7+ format : text # Supported values: text, json.
98
10- access_log :
11- file : /dev/stdout
12- format : text # supported values are " text" and " json"
9+ access_log : # Access Log
10+ file : /dev/stdout # Specifies the log file.
11+ format : text # Supported values: text, json.
1312
1413database :
1514 host : localhost
1615 port : 5432
1716 username : webhookx
1817 password :
1918 database : webhookx
20- parameters : ' application_name=webhookx&sslmode=disable&connect_timeout=10' # The connection uri parameters.
21- # See https://www.postgresql.org/docs/current/libpq-connect.html
22- max_pool_size : 40 # The maximum number of connections
23- max_lifetime : 1800 # The maximum lifetime (in seconds) of a connection
19+ parameters : ' application_name=webhookx&sslmode=disable&connect_timeout=10'
20+ # Connection uri parameters.
21+ # See https://www.postgresql.org/docs/current/libpq-connect.html for more information.
22+ max_pool_size : 40 # Specifies the maximum number of connections.
23+ max_lifetime : 1800 # Specifies the maximum lifetime (in seconds) for a connection.
2424
2525redis :
2626 host : localhost
@@ -29,47 +29,55 @@ redis:
2929 database : 0
3030
3131# ------------------------------------------------------------------------------
32- # Cluster
32+ # PROXY
3333# ------------------------------------------------------------------------------
34- # role: standalone # Enables cluster mode.
35- # This allows some nodes in the cluster to run as the control plane
36- # and others to run as the data plane.
37- #
38- # supported values are:
39- #
40- # - `standalone`: disable cluster mode.
41- # - `cp`: this node runs as the control plane.
42- # It connects to the database to provide entity management.
43- # - `dp_proxy`: this node runs as the Proxy data plane.
44- # - `dp_worker`: this node runs as the Worker data plane.
45-
46- anonymous_reports : true # sends anonymous data such as software version to WebhookX.
34+ proxy :
35+ listen : 0.0.0.0:9600
36+ tls : # TLS configuration
37+ cert : ' ' # The path to TLS certificate. Example: /path/to/server.cert
38+ key : ' ' # The path to TLS certificate key. Example: /path/to/server.key
39+ timeout_read : 10 # Specifies the maximum time (in seconds) for reading request. 0 disables timeout.
40+ timeout_write : 10 # Specifies the maximum time (in seconds) for writing response. 0 disables timeout.
41+ max_request_body_size : 1048576 # Specifies the maximum request body size. Default is 1048576.
42+ response : # Default HTTP response
43+ code : 200
44+ content_type : application/json
45+ body : ' {"message": "OK"}'
46+ queue : # Queue settings
47+ type : redis # Queue type. Supported values: redis, off.
48+ redis :
49+ host : localhost
50+ port : 6379
51+ password :
52+ database : 0
4753
4854# ------------------------------------------------------------------------------
49- # ADMIN
55+ # Admin API
56+ # The Admin API provides RESTful APIs for managing entities.
5057# ------------------------------------------------------------------------------
51-
5258admin :
53- # listen: 127.0.0.1:8080
54- # debug_endpoints: true # enables debugging and profiling endpoints. see https://pkg.go.dev/net/http/pprof
55- # tls:
56- # cert: /path/to/server.crt
57- # key: /path/to/server.key
59+ listen : 127.0.0.1:9601
60+ debug_endpoints : false # Whether to expose debugging and profiling endpoints.
61+ # See https://pkg.go.dev/net/http/pprof for more information.
62+ # tls: # TLS configuration
63+ # cert: /path/to/server.crt # The Path to TLS certificate.
64+ # key: /path/to/server.key # The path to TLS certificate key.
5865
5966# ------------------------------------------------------------------------------
60- # STATUS
67+ # Status API
68+ # The Status API provides APIs for retrieving runtime status about WebhookX.
6169# ------------------------------------------------------------------------------
62-
6370status :
64- listen : 127.0.0.1:8082
65- debug_endpoints : true # enables debugging and profiling endpoints. see https://pkg.go.dev/net/http/pprof
71+ listen : 127.0.0.1:9602
72+ debug_endpoints : true # Whether to expose debugging and profiling endpoints.
73+ # See https://pkg.go.dev/net/http/pprof for more information.
6674
6775# ------------------------------------------------------------------------------
68- # WORKER
76+ # Worker
77+ # The Worker sends events to destinations.
6978# ------------------------------------------------------------------------------
70-
7179worker :
72- enabled : false # Whether to enable the Worker.
80+ enabled : true # Whether to enable the Worker.
7381 deliverer :
7482 timeout : 60000 # Sets the request timeout (in milliseconds) for delivery requests.
7583 acl : # Access Control List (ACL) defines rules to control outbound network access.
@@ -105,28 +113,22 @@ worker:
105113 concurrency : 0 # pool concurrency, default to 100 * CPUs
106114
107115# ------------------------------------------------------------------------------
108- # PROXY
116+ # Cluster
109117# ------------------------------------------------------------------------------
110- proxy :
111- # listen: 127.0.0.1:8081
112- # tls:
113- # cert: /path/to/server.crt
114- # key: /path/to/server.key
115- timeout_read : 10 # read timeout (in seconds), 0 indicates unlimited.
116- timeout_write : 60 # write timeout (in seconds), 0 indicates unlimited.
117- max_request_body_size : 1048576
118- response :
119- code : 200
120- content_type : application/json
121- body : ' {"message": "OK"}'
118+ # role: standalone # Enables cluster mode.
119+ # This allows some nodes in the cluster to run as the control plane
120+ # and others to run as the data plane.
121+ #
122+ # supported values are:
123+ #
124+ # - `standalone`: disable cluster mode.
125+ # - `cp`: this node runs as the control plane.
126+ # It connects to the database to provide entity management.
127+ # - `dp_proxy`: this node runs as the Proxy data plane.
128+ # - `dp_worker`: this node runs as the Worker data plane.
129+
130+ anonymous_reports : true # sends anonymous data such as software version to WebhookX.
122131
123- queue :
124- type : redis # supported values are redis, off
125- redis :
126- host : localhost
127- port : 6379
128- password :
129- database : 0
130132
131133# ------------------------------------------------------------------------------
132134# METRICS
@@ -137,7 +139,7 @@ metrics:
137139 # exports: [ opentelemetry ] # list of enabled vendor exports. supported value are opentelemetry
138140 push_interval : 10 # interval(in seconds) at which metrics are sent to the OpenTelemetry Collector
139141 opentelemetry :
140- protocol : http/protobuf # supported value are http/protobuf, grpc
142+ protocol : http/protobuf # Supported values: http/protobuf, grpc.
141143 endpoint : http://localhost:4318/v1/metrics # http/protobuf(http://localhost:4318/v1/metrics), grpc(localhost:4317)
142144
143145# ------------------------------------------------------------------------------
@@ -149,5 +151,5 @@ tracing:
149151 env : prod
150152 sampling_rate : 1.0
151153 opentelemetry :
152- protocol : http/protobuf # supported value are http/protobuf, grpc
154+ protocol : http/protobuf # Supported value: http/protobuf, grpc.
153155 endpoint : http://localhost:4318/v1/traces # http/protobuf(http://localhost:4318/v1/traces), grpc(localhost:4317)
0 commit comments