-
-
Notifications
You must be signed in to change notification settings - Fork 414
/
.rr.yaml
2195 lines (1836 loc) · 62.5 KB
/
.rr.yaml
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
######################################################################################
# THIS IS SAMPLE OF THE CONFIGURATION #
# IT'S NOT A DEFAULT CONFIGURATION, IT'S JUST A REFERENCE TO ALL OPTIONS AND PLUGINS #
# MORE DOCS CAN BE FOUND HERE: <https://roadrunner.dev/docs/intro-config> #
######################################################################################
# Production usage guide: https://roadrunner.dev/docs/app-server-production/2.x/en
# Hint: RR will replace any config options using reference to environment variables,
# eg.: `option_key: ${ENVIRONMENT_VARIABLE_NAME}`.
# Important: TCP port numbers for each plugin (rpc, http, etc) must be unique!
# RR configuration version
version: '3'
# Remote Procedures Calling (docs: https://roadrunner.dev/docs/plugins-rpc/2.x/en)
# Is used for connecting to RoadRunner server from your PHP workers.
rpc:
# TCP address:port for listening.
#
# Default: "tcp://127.0.0.1:6001"
listen: tcp://127.0.0.1:6001
# Application server settings (docs: https://roadrunner.dev/docs/php-worker)
server:
# Execute command before the main server's command.
on_init:
# Command to execute before the main server's command
#
# This option is required if using on_init
command: "any php or script here"
# Script execute timeout
#
# Default: 60s [60m, 60h], if used w/o units its means - NANOSECONDS.
exec_timeout: 20s
# Exit on init error
# Default: false
exit_on_error: false
# Environment variables for the worker processes.
#
# Default: <empty map>
env:
SOME_KEY: "SOME_VALUE"
SOME_KEY2: "SOME_VALUE2"
# Username (not UID) of the user from whom the on_init command is executed. An empty value means to use the RR process user.
#
# Default: ""
# user: ""
# Worker starting command, with any required arguments.
#
# This option is required.
command: "php psr-worker.php"
# Username (not UID) for the worker processes. An empty value means to use the RR process user.
#
# Default: ""
# user: ""
# Group name (not GID) for the worker processes. An empty value means to use the RR process group.
#
# Default: ""
# group: ""
# Environment variables for the worker processes.
#
# Default: <empty map>
env:
SOME_KEY: "SOME_VALUE"
SOME_KEY2: "SOME_VALUE2"
# Worker relay can be: "pipes", TCP (eg.: tcp://127.0.0.1:6002), or socket (eg.: unix:///var/run/rr.sock).
#
# Default: "pipes"
relay: pipes
# Logging settings (docs: https://roadrunner.dev/docs/plugins-logger/2.x/en)
logs:
# Logging mode can be "development", "production" or "raw". Do not forget to change this value for production environment.
#
# Development mode (which makes DPanicLevel logs panic), uses a console encoder, writes to standard error, and
# disables sampling. Stacktraces are automatically included on logs of WarnLevel and above.
#
# Default: "development"
mode: development
# Logging level can be "panic", "error", "warn", "info", "debug".
#
# Default: "debug"
level: debug
# Encoding format can be "console" or "json" (last is preferred for production usage).
#
# Default: "console"
encoding: console
# Log line ending
#
# Default: "\n"
line_ending: "\n"
# Output can be file (eg.: "/var/log/rr_errors.log"), "stderr" or "stdout".
#
# Default: "stderr"
output: ["stderr"]
# Errors only output can be file (eg.: "/var/log/rr_errors.log"), "stderr" or "stdout".
#
# Default: ["stderr"]
err_output: ["stderr"]
# File logger options
#
# Default: null
file_logger_options:
# Path to the file
#
# Default: It uses <processname>-lumberjack.log name in the os tempdir if empty.
log_output: "/tmp/my.log"
# Max file size in MB
#
# Default: 100
max_size: 100
# max_age is the maximum number of days to retain old log files based on the timestamp encoded in their filename.
#
# Default: 1 (day)
max_age: 1
# max_backups is the maximum number of old log files to retain.
#
# Default: retain all (if set to 0)
max_backups: 5
# Compress determines if the rotated log files should be compressed using gzip.
#
# Default: false
compress: false
# You can configure each plugin log messages individually (key is plugin name, and value is logging options in same
# format as above).
#
# Default: <empty map>
channels:
http:
mode: development
level: panic
encoding: console
output: ["stdout"]
err_output: ["stderr"]
server:
mode: production
level: info
encoding: json
output: ["stdout"]
err_output: ["stdout"]
rpc:
mode: raw
level: debug
encoding: console
output: ["stderr"]
err_output: ["stdout"]
# Workflow and activity mesh service.
#
# Drop this section for temporal feature disabling.
temporal:
# Address of temporal server.
#
# Default: "127.0.0.1:7233"
address: 127.0.0.1:7233
# Sticky cache size. Sticky workflow execution is the affinity
# between workflow tasks of a specific workflow execution to a specific worker. The benefit of sticky execution is that
# the workflow does not have to reconstruct state by replaying history from the beginning. The cache is shared between
# workers running within same process. This must be called before any worker is started. If not called, the default
# size of 10K (which may change) will be used.
#
# Default: 10_000
cache_size: 10000
# Namespace name for this client to work with
#
# Default: default
namespace: default
# Temporal metrics
#
# Optional section
metrics:
# Metrics driver to use
# Optional, default: prometheus. Available values: prometheus, statsd
driver: prometheus
# ---- Prometheus
prometheus:
# Server metrics address
# Required for the production. Default: 127.0.0.1:9091, for the metrics 127.0.0.1:9091/metrics
address: 127.0.0.1:9091
# Metrics type
type: "summary"
# Temporal metrics prefix
# Default: (empty)
prefix: "foobar"
# ---- Statsd (uncomment)
# Statsd host and port
#statsd:
# Optional
# default: 127.0.0.1:8125
# host_port: "127.0.0.1:8125"
#
# Prefix for the metrics
# Optional, default: empty
# prefix: "samples"
#
# Flush interval is the maximum interval for sending packets.
# Optional, default: 1s
# flush_interval: 1s
#
# Flush bytes specifies the maximum udp packet size you wish to send.
# If FlushBytes is unspecified, it defaults to 1432 bytes, which is
# considered safe for local traffic
# Optional, default: 1432
# flush_bytes: 1432
#
# Tags passed to the statsd on init
# Optional, default: empty
#tags:
# foo: bar
# Temporal TLS configuration
#
# This section is optional
tls:
# Path to the key file
#
# This option is required
key: "/ssl/key.pem"
# Path to the certificate
#
# This option is required
cert: "/ssl/cert.crt"
# Path to the CA certificate, defines the set of root certificate authorities that servers use if required to verify a client certificate. Used with the `client_auth_type` option.
#
# This option is optional
root_ca: "/ssl/ca.crt"
# Client auth type.
#
# This option is optional. Default value: no_client_certs. Possible values: request_client_cert, require_any_client_cert, verify_client_cert_if_given, require_and_verify_client_cert, no_client_certs
client_auth_type: no_client_certs
# ServerName is used to verify the hostname on the returned
# certificates unless InsecureSkipVerify is given. It is also included
# in the client's handshake to support virtual hosting unless it is
# an IP address.
#
# Default: hostname
server_name: "tls-sample"
# Activities pool settings.
#
# Equal to the regular pool options
activities:
# Debug mode for the pool. In this mode, pool will not pre-allocate the worker. Worker (only 1, num_workers ignored) will be allocated right after the request arrived.
#
# Default: false
debug: false
# Override server's command
#
# Default: empty
command: "php my-super-app.php"
# How many worker processes will be started. Zero (or nothing) means the number of logical CPUs.
#
# Default: 0
num_workers: 0
# Maximal count of worker executions. Zero (or nothing) means no limit.
#
# Default: 0
max_jobs: 0
# [2023.3.10]
# Maximum size of the internal requests queue. After reaching the limit, all additional requests would be rejected with error.
#
# Default: 0 (no limit)
max_queue_size: 0
# Timeout for worker allocation. Zero means 60s.
#
# Default: 60s
allocate_timeout: 60s
# Timeout for the reset timeout. Zero means 60s.
#
# Default: 60s
reset_timeout: 60s
# Timeout for worker destroying before process killing. Zero means 60s.
#
# Default: 60s
destroy_timeout: 60s
# Supervisor is used to control http workers (previous name was "limit", docs:
# https://roadrunner.dev/docs/php-limit). "Soft" limits will not interrupt current request processing. "Hard"
# limit on the contrary - interrupts the execution of the request.
supervisor:
# How often to check the state of the workers.
#
# Default: 1s
watch_tick: 1s
# Maximum time worker is allowed to live (soft limit). Zero means no limit.
#
# Default: 0s
ttl: 0s
# How long worker can spend in IDLE mode after first using (soft limit). Zero means no limit.
#
# Default: 0s
idle_ttl: 10s
# Maximal worker memory usage in megabytes (soft limit). Zero means no limit.
#
# Default: 0
max_worker_memory: 128
# Maximal job lifetime (hard limit). Zero means no limit.
#
# Default: 0s
exec_ttl: 60s
# KV plugin settings. Available drivers: boltdb, redis, memcached, memory.
#
# Any number of sections can be defined here.
kv:
# User defined name of the section
#
# Default: none
boltdb-south:
# Driver which should be used for the storage
#
# This option is required.
driver: boltdb
# Local configuration section
#
# This option is required to use local section, otherwise (boltdb-south) global configuration will be used.
config:
# File name for the DB
#
# Default: "rr.db"
file: "rr.db"
# Access permission for the DB file.
#
# Default: "0755"
permissions: 0755
# TTL keys check interval in seconds. It's safe to use 1 second here, but can be a little costly to performance.
#
# Default: "60" seconds
interval: 40
# User defined name of the section (us-cental-kv used as example)
#
# Default: none
us-central-kv:
# Driver which should be used for the storage
#
# Default: none
driver: memcached
# Local configuration section
#
# This option is required to use local section, otherwise (us-central-kv) global configuration will be used.
config:
# Driver specific section. Addresses of the memcached node(s).
#
# Default: [ "localhost:11211" ]
addr: [ "localhost:11211" ]
# User defined name of the section
#
# Default: none
fast-kv-fr:
# Driver which should be used for the storage.
#
# Default: none
driver: redis
# Redis specific section. If one address provided - single node client will be used.
#
#
# UniversalClient is an abstract client which - based on the provided options -
# can connect to either clusters, or sentinel-backed failover instances
# or simple single-instance servers. This can be useful for testing
# cluster-specific applications locally.
# if the number of addrs is 1 and master_name is empty, a single-node redis Client will be returned
# if the number of addrs is two or more, a ClusterClient will be returned
# Local configuration section
#
# This option is required to use local section, otherwise (fast-kv-fr) global configuration will be used.
config:
addrs:
- "localhost:6379"
# if a MasterName is passed a sentinel-backed FailoverClient will be returned
master_name: ""
username: ""
password: ""
db: 0
sentinel_password: ""
route_by_latency: false
route_randomly: false
dial_timeout: 0s # accepted values [1s, 5m, 3h]
max_retries: 1
min_retry_backoff: 0s # accepted values [1s, 5m, 3h]
max_retry_backoff: 0s # accepted values [1s, 5m, 3h]
pool_size: 0
min_idle_conns: 0
max_conn_age: 0s # accepted values [1s, 5m, 3h]
read_timeout: 0s # accepted values [1s, 5m, 3h]
write_timeout: 0s # accepted values [1s, 5m, 3h]
pool_timeout: 0s # accepted values [1s, 5m, 3h]
idle_timeout: 0s # accepted values [1s, 5m, 3h]
idle_check_freq: 0s # accepted values [1s, 5m, 3h]
read_only: false
# User defined name of the section
#
# Default: none
local-memory:
# In memory driver specific section
#
# Default: none
driver: memory
config: { }
# Service plugin settings
service:
# User defined service name
#
# Default: none, required
some_service_1:
# Command to execute. Can be any command here which can be executed.
#
# Default: none, required.
command: php tests/plugins/service/test_files/loop.php
# Env variables for the process
#
# Default: empty
env:
foo: "BAR"
foo2: "BAR2"
# Number of copies (processes) to start per command.
#
# Default: 1
process_num: 1
# Timeout for the process stop operation
#
# Default: 5 seconds
timeout_stop_sec: 5
# Allowed time before stop.
#
# Default: 0 (infinity), can be 1s, 2m, 2h (seconds, minutes, hours) and complex 2h2m1s.
exec_timeout: 0s
# Show the name of the service in logs (e.g. service.some_service_1)
#
# Default: false
service_name_in_log: false
# Remain process after exit. In other words, restart process after exit with any exit code.
#
# Default: "false"
remain_after_exit: true
# Number of seconds to wait before process restart.
#
# Default: 30
restart_sec: 1
# User defined service name
#
# Default: none, required
some_service_2:
# Command to execute. Can be any command here which can be executed.
#
# Default: none, required.
command: "binary"
# Timeout for the process stop operation
#
# Default: 5 seconds
timeout_stop_sec: 5
# Env variables for the process
#
# Default: empty
env:
foo: "BAR"
foo2: "BAR2"
# Number of copies (processes) to start per command.
#
# Default: 1
process_num: 1
# Show the name of the service in logs (e.g. service.some_service_1)
#
# Default: false
service_name_in_log: false
# Allowed time before stop.
#
# Default: 0 (infinity), can be 1s, 2m, 2h (seconds, minutes, hours) and complex 2h2m1s.
exec_timeout: 0s
# Remain process after exit. In other words, restart process after exit with any exit code.
#
# Default: "false"
remain_after_exit: true
# Number of seconds to wait before process restart.
#
# Default: 30
restart_sec: 1
otel:
# OpenTelemetry Resources
#
# https://github.com/open-telemetry/opentelemetry-specification/blob/v1.25.0/specification/resource/semantic_conventions/README.md
resource:
# User's service name
#
# Default: RoadRunner
service_name: "rr_test"
# User's service version
#
# Default: RoadRunner
service_version: "1.0.0"
# User's service namespace
#
# Default: RoadRunner
service_namespace: "RR-Shop"
# User's service instance id
#
# Default: Generated UUID
service_instance_id: "UUID"
# Use insecure endpoint (http) or insecure gRPC
#
# Default: false
insecure: true
# Use gzip to compress the spans
#
# Default: false
compress: false
# Client to send the spans
#
# Default: http. Possible values: `http`, `grpc`
client: http
# Provides functionality to emit telemetry to consumers
#
# Default: otlp. Possible values: otlp (used for new_relic, datadog), zipkin stderr or stdout
exporter: otlp
# Used for the http client to override the default URL
#
# Default: empty
# custom_url: ""
# Consumer's endpoint
#
# Default: 127.0.0.1:4318
endpoint: "127.0.0.1:4318"
# HTTP plugin settings.
http:
# Host and port to listen on (eg.: `127.0.0.1:8080`).
#
# This option is required.
address: 127.0.0.1:8080
# override http error code for the internal RR errors
#
# Default: 500
internal_error_code: 505
# HTTP access logs
#
# Default: false
access_logs: false
# Maximal incoming request size in megabytes. Zero means no limit.
#
# Default: 0
max_request_size: 256
# Send raw body (unescaped) to the PHP worker for the application/x-www-form-urlencoded content type
#
# Optional, default: false
raw_body: false
# Middlewares for the http plugin, order is important. Allowed values is: "headers", "gzip", "static", "sendfile", [SINCE 2.6] -> "new_relic", [SINCE 2.6] -> "http_metrics", [SINCE 2.7] -> "cache"
#
# Default value: []
middleware: [ "headers", "gzip" ]
# Allow incoming requests only from the following subnets (https://en.wikipedia.org/wiki/Reserved_IP_addresses).
#
# Default: ["10.0.0.0/8", "127.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16", "::1/128", "fc00::/7", "fe80::/10"]
trusted_subnets:
[
"10.0.0.0/8",
"127.0.0.0/8",
"172.16.0.0/12",
"192.168.0.0/16",
"::1/128",
"fc00::/7",
"fe80::/10",
]
# File uploading settings.
uploads:
# Directory for file uploads. Empty value means to use $TEMP based on your OS.
#
# Default: ""
dir: "/tmp"
# Deny files with the following extensions to upload.
#
# Default: [".php", ".exe", ".bat"]
forbid: [ ".php", ".exe", ".bat", ".sh" ]
# [SINCE 2.6] Allow files with the following extensions to upload
#
# Default: empty
allow: [ ".html", ".aaa" ]
# Settings for "headers" middleware (docs: https://roadrunner.dev/docs/middleware-headers/2.x/en).
headers:
# Allows to control CORS headers. Additional headers "Vary: Origin", "Vary: Access-Control-Request-Method",
# "Vary: Access-Control-Request-Headers" will be added to the server responses. Drop this section for this
# feature disabling.
cors:
# Controls "Access-Control-Allow-Origin" header value (docs: https://mzl.la/2OgD4Qf).
#
# Default: empty
allowed_origin: "*"
# Controls "Access-Control-Allow-Origin" header value (docs: https://mzl.la/2OgD4Qf).
#
# Default: empty. If set, overrides allowed_origin.
allowed_origin_regex: "^https://foo"
# Controls "Access-Control-Allow-Headers" header value (docs: https://mzl.la/2OzDVvk).
#
# Default: ""
allowed_headers: "*"
# Controls "Access-Control-Allow-Methods" header value (docs: https://mzl.la/3lbwyXf).
#
# Default: ""
allowed_methods: "GET,POST,PUT,DELETE"
# Controls "Access-Control-Allow-Credentials" header value (docs: https://mzl.la/3ekJGaY).
#
# Default: false
allow_credentials: true
# Controls "Access-Control-Expose-Headers" header value (docs: https://mzl.la/3qAqgkF).
#
# Default: ""
exposed_headers: "Cache-Control,Content-Language,Content-Type,Expires,Last-Modified,Pragma"
# Controls "Access-Control-Max-Age" header value in seconds (docs: https://mzl.la/2PCSdvt).
#
# Default: 0
max_age: 600
# Automatically add headers to every request passed to PHP.
#
# Default: <empty map>
request:
input: "custom-header"
# Automatically add headers to every response.
#
# Default: <empty map>
response:
X-Powered-By: "RoadRunner"
# Settings for "static" middleware (docs: https://roadrunner.dev/docs/middleware-static/2.x/en).
static:
# Path to the directory to serve
#
# Default: "." (current)
dir: "."
# File patterns to forbid
#
# Default: empty
forbid: [ ]
# Etag calculation (base on the body CRC32)
#
# Default: false
calculate_etag: false
# Weak etag calculation (based only on the content-length CRC32)
#
# Default: false
weak: false
# Patterns to allow
#
# Default: empty
allow: [ ".txt", ".php" ]
# Request headers
#
# Default: empty
request:
input: "custom-header"
# Response headers
#
# Default: empty
response:
output: "output-header"
# Workers pool settings.
pool:
# Debug mode for the pool. In this mode, pool will not pre-allocate the worker. Worker (only 1, num_workers ignored) will be allocated right after the request arrived.
#
# Default: false
debug: false
# Override server's command
#
# Default: empty
command: "php my-super-app.php"
# How many worker processes will be started. Zero (or nothing) means the number of logical CPUs.
#
# Default: 0
num_workers: 0
# Maximal count of worker executions. Zero (or nothing) means no limit.
#
# Default: 0
max_jobs: 0
# [2023.3.10]
# Maximum size of the internal requests queue. After reaching the limit, all additional requests would be rejected with error.
#
# Default: 0 (no limit)
max_queue_size: 0
# Timeout for worker allocation. Zero means 60s.
#
# Default: 60s
allocate_timeout: 60s
# Timeout for the reset timeout. Zero means 60s.
#
# Default: 60s
reset_timeout: 60s
# Timeout for the stream cancellation. Zero means 60s.
#
# Default: 60s
stream_timeout: 60s
# Timeout for worker destroying before process killing. Zero means 60s.
#
# Default: 60s
destroy_timeout: 60s
# Dynamic allocator settings.
#
# Default: empty
dynamic_allocator:
max_workers: 25
spawn_rate: 10
idle_timeout: 10s
# Supervisor is used to control http workers (previous name was "limit", video: https://www.youtube.com/watch?v=NdrlZhyFqyQ).
# "Soft" limits will not interrupt current request processing. "Hard"
# limit on the contrary - interrupts the execution of the request.
supervisor:
# How often to check the state of the workers.
#
# Default: 1s
watch_tick: 1s
# Maximum time worker is allowed to live (soft limit). Zero means no limit.
#
# Default: 0s
ttl: 0s
# How long worker can spend in IDLE mode after first using (soft limit). Zero means no limit.
#
# Default: 0s
idle_ttl: 10s
# Maximal worker memory usage in megabytes (soft limit). Zero means no limit.
#
# Default: 0
max_worker_memory: 128
# Maximal job lifetime (hard limit). Zero means no limit.
#
# Default: 0s
exec_ttl: 60s
# SSL (Secure Sockets Layer) (TLS) settings (docs: https://roadrunner.dev/docs/app-server-https/2.x/en).
ssl:
# Host and port to listen on (eg.: `127.0.0.1:443`).
#
# Default: ":443"
address: "127.0.0.1:443"
# Use ACME certificates provider (Let's encrypt)
# Must not be specified if key + cert is used.
acme:
# Directory to use as a certificate/pk, account info storage
#
# Optional. Default: rr_cache
cache_dir: "rr_le_certs"
# User email
#
# Used to create LE account. Mandatory. Error on empty.
email: your-email-here@email
# Alternate port for the http challenge. Challenge traffic should be redirected to this port if overridden.
#
# Optional. Default: 80
alt_http_port: 80
# Alternate port for the tls-alpn-01 challenge. Challenge traffic should be redirected to this port if overridden.
#
# Optional. Default: 443.
alt_tlsalpn_port: 443
# Challenge types
#
# Optional. Default: http-01. Possible values: http-01, tlsalpn-01
challenge_type: http-01
# Use production or staging endpoint. NOTE, try to use staging endpoint to make sure, that everything works correctly.
#
# Optional, but for production should be set to true. Default: false
use_production_endpoint: true
# List of your domains to obtain certificates
#
# Mandatory. Error on empty.
domains: [
"your-cool-domain.here",
"your-second-domain.here"
]
# Automatic redirect from http:// to https:// schema.
#
# Default: false
redirect: true
# Path to the cert file. This option is required for SSL. Must not be specified if ACME is used.
#
# This option is required.
# cert: "/ssl/cert.crt"
# Path to the cert key file. Must not be specified if ACME is used.
#
# This option is required.
# key: "/ssl/key.pem"
# Path to the root certificate authority file.
#
# This option is optional (required for the mTLS). Must not be specified if ACME is used.
# root_ca: "/ssl/ca.crt"
# Client auth type (mTLS). Must not be specified if ACME is used.
#
# This option is optional. Default value: no_client_certs. Possible values: request_client_cert, require_any_client_cert, verify_client_cert_if_given, require_and_verify_client_cert, no_client_certs
# client_auth_type: no_client_certs
# FastCGI frontend support.
fcgi:
# FastCGI connection DSN. Supported TCP and Unix sockets. An empty value disables this.
#
# Default: ""
address: tcp://0.0.0.0:7921
# HTTP/2 settings.
http2:
# HTTP/2 over non-encrypted TCP connection using H2C.
#
# Default: false
h2c: false
# Maximal concurrent streams count.
#
# Default: 128
max_concurrent_streams: 128
# Redis section.
redis:
# UniversalClient is an abstract client which - based on the provided options -
# can connect to either clusters, or sentinel-backed failover instances
# or simple single-instance servers. This can be useful for testing
# cluster-specific applications locally.
# if the number of addrs is 1 and master_name is empty, a single-node redis Client will be returned
# if the number of addrs is two or more, a ClusterClient will be returned
addrs:
- "localhost:6379"
# if a MasterName is passed a sentinel-backed FailoverClient will be returned
master_name: ""
username: ""
password: ""
db: 0
sentinel_password: ""
route_by_latency: false
route_randomly: false
dial_timeout: 0s # accepted values [1s, 5m, 3h]
max_retries: 1
min_retry_backoff: 0s # accepted values [1s, 5m, 3h]
max_retry_backoff: 0s # accepted values [1s, 5m, 3h]
pool_size: 0
min_idle_conns: 0
max_conn_age: 0s # accepted values [1s, 5m, 3h]
read_timeout: 0s # accepted values [1s, 5m, 3h]
write_timeout: 0s # accepted values [1s, 5m, 3h]
pool_timeout: 0s # accepted values [1s, 5m, 3h]
idle_timeout: 0s # accepted values [1s, 5m, 3h]
idle_check_freq: 0s # accepted values [1s, 5m, 3h]
read_only: false
# Application metrics in Prometheus format (docs: https://roadrunner.dev/docs/plugins-metrics/2.x/en). Drop this section
# for this feature disabling.
metrics:
# Prometheus client address (path /metrics added automatically).
#
# Default: "127.0.0.1:2112"
address: "127.0.0.1:2112"
# Application-specific metrics (published using an RPC connection to the server).
collect:
app_metric_summary:
type: summary
help: "Custom summary application metric"
labels: [ "type" ]
# Objectives defines the quantile rank estimates with their respective absolute error (for summary only).
objectives:
0.1: 2.3
1.0: 1.4
app_metric_histogram:
type: histogram
help: "Custom histogram application metric"
labels: [ "type" ]
buckets: [ 0.1, 0.2, 0.3, 1.0 ]
# Health check endpoint (docs: https://roadrunner.dev/docs/app-server-health/2.x/en). If response code is 200 - it means at
# least one worker ready to serve requests. 500 - there are no workers ready to service requests.
# Drop this section for this feature disabling.
status:
# Host and port to listen on (eg.: `127.0.0.1:2114`). Use the following URL: http://127.0.0.1:2114/health?plugin=http
# Multiple plugins must be separated using "&" - http://127.0.0.1:2114/health?plugin=http&plugin=rpc where "http" and
# "rpc" are active (connected) plugins.
#
# This option is required.
address: 127.0.0.1:2114