archive/pingora
1
0
Fork 0
mirror of https://github.com/cloudflare/pingora.git synced 2024-09-20 10:41:35 +02:00
Code Issues Projects Releases Packages Wiki Activity
pingora/docs/user_guide/conf.md
Yuchen Wu 8160ad1698 Fix typos and grammar issues 
Co-authored-by: =?~~~?q?Ren=C3=A9=20Kla=C4=8Dan?= <rene@klacan.sk>
Co-authored-by: 12932 <68835423+12932@users.noreply.github.com>
Co-authored-by: Alessandro <aleferrara1998@gmail.com>
Co-authored-by: InImpasse <40639475+InImpasse@users.noreply.github.com>
Co-authored-by: Paul James Cleary <pauljamescleary@gmail.com>
Co-authored-by: Yang Hau <yuanyanghau@gmail.com>
Co-authored-by: Morpheus <40785143+Muzych@users.noreply.github.com>
Co-authored-by: mobeicanyue <81098819+mobeicanyue@users.noreply.github.com>
Co-authored-by: Twacqwq <69360546+Twacqwq@users.noreply.github.com>
Co-authored-by: Bobby <zkd8907@live.com>
Co-authored-by: Dup4 <lyuzhi.pan@gmail.com>
Co-authored-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Co-authored-by: Sheldon <1415182877@qq.com>
Co-authored-by: houseme <housemecn@gmail.com>
Co-authored-by: ZhangIvan1 <zhang_ivan1@163.com>
Co-authored-by: GrahamQuan <33834833+GrahamQuan@users.noreply.github.com>
Co-authored-by: =?~~~?q?Cristian=20Paul=20Pe=C3=B1aranda=20Rojas?= <paul@kristianpaul.org>
Co-authored-by: Nathan Sit <nsit.earth@gmail.com>
Co-authored-by: David Lee <67067729+LordMoMA@users.noreply.github.com>
Co-authored-by: Mengliang Su <mengliang.su@shopee.com>
Co-authored-by: =?~~~?q?=EA=B9=80=EC=84=A0=EC=9A=B0?= <seonwoo960000@toss.im>
Co-authored-by: Allen Huang <huangseji@meituan.com>
Co-authored-by: Opacity <70315161+zreren@users.noreply.github.com>
Co-authored-by: cris <sqdcmk@gmail.com>
Co-authored-by: Killian Ye <40255385+ykw1129@users.noreply.github.com>
Co-authored-by: Jiwei-dev <hi.jiwei@gmail.com>
Co-authored-by: Jinfeng Wang <41931794+wjf40390@users.noreply.github.com>
Co-authored-by: Ikko Eltociear Ashimine <eltociear@gmail.com>
2024-03-01 13:47:27 -08:00

1.5 KiB
Raw Blame History

Configuration

A Pingora configuration file is a list of Pingora settings in yaml format.

Example

---
version: 1
threads: 2
pid_file: /run/pingora.pid
upgrade_sock: /tmp/pingora_upgrade.sock
user: nobody
group: webusers

Settings

Key meaning value type
version the version of the conf, currently it is a constant 1 number
pid_file The path to the pid file string
daemon whether to run the server in the background bool
error_log the path to error log output file. STDERR is used if not set string
upgrade_sock the path to the upgrade socket. string
threads number of threads per service number
user the user the pingora server should be run under after daemonization string
group the group the pingora server should be run under after daemonization string
client_bind_to_ipv4 source IPv4 addresses to bind to when connecting to server list of string
client_bind_to_ipv6 source IPv6 addresses to bind to when connecting to server list of string
ca_file The path to the root CA file string
work_stealing Enable work stealing runtime (default true). See Pingora runtime (WIP) section for more info bool
upstream_keepalive_pool_size The number of total connections to keep in the connection pool number

Extension

Any unknown settings will be ignored. This allows extending the conf file to add and pass user defined settings. See User defined configuration section.