141 Commits

Author SHA1 Message Date
Tanmoy Sarkar
db212bdc12 docs: Regenerate settings.rst for companion settings
The docs CI builds Sphinx, which regenerates settings.rst from the
Setting classes in config.py and fails if the working tree changes. The
new Companion Processes settings were missing from the committed file.
Regenerate it (also picks up a stale grp.getgrnam line).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-12 23:57:24 +05:30
Benoit Chesneau
3acd9fbfd1
Merge pull request #2620 from talkerbox/improve-access-log-format-docs
Improve access-log-format documentation section
2024-08-10 09:56:56 +02:00
Benoit Chesneau
3f56d76548
Merge pull request #3192 from pajod/patch-allowed-script-name
22.0.0 regression: We need a better default treatment of SCRIPT_NAME
2024-08-09 09:05:57 +02:00
Paul J. Dorn
687b78d20c config defaults: PATH_NAME and ::1 for proxy
* PATH_NAME is used like SCRIPT_NAME: include both
* replicate changed forwarded-allow-ips default to proxy_allow_ips
2024-08-08 18:15:42 +02:00
Paul J. Dorn
3e042e8269 Configurable list of forwarder headers 2024-08-07 20:15:13 +02:00
Paul J. Dorn
01bcdb1d12 Exempt SCRIPT_NAME from newly introduced --header-map treatment 2024-08-07 20:10:47 +02:00
Paul J. Dorn
2bc931e7d9 whitespace handling in header field values
Strip whitespace also *after* header field value.
Simply refuse obsolete header folding (a default-off
option to revert is temporarily provided).
While we are at it, explicitly handle recently
introduced http error classes with intended status code.
2024-08-07 19:42:16 +02:00
Paul J. Dorn
6c3296e177 update docs
re-apply typo fix from 628a0bcb61ef3a211d67dfd68ad1ba161cccb3b8
reflect removal of setting from 555d2fa27f2d891f23bd03890e4a826b5018c6b4
2024-08-07 18:21:36 +02:00
Paul J. Dorn
70a1e437b5 forbid lone CR/LF and NUL in headers (docs) 2024-07-31 17:39:13 +02:00
Paul J. Dorn
e3fa50d1c5 update docs 2024-07-31 01:21:01 +02:00
Eisuke Kawashima
628a0bcb61
chore: fix typos 2024-03-25 08:31:59 +09:00
benoitc
b6eb01ba52 add readthedocs.yaml 2023-07-17 23:03:59 +02:00
Tero Saarni
d8c3b1490e Deprecate ssl_version option
This change defaults SSLContext to Python's ssl.create_default_context() and
marks ssl_version option as deprecated. The option value will be ignored and
warnign will be printed in stderr.

The ssl_version option was depending on old method of setting TLS min/max
version, which has not worked well anymore with modern Python versions.
2023-05-11 17:45:57 +03:00
Benoit Chesneau
f859de498a
Merge pull request #2634 from YingjieQiao/docs/cert_reqs
docs: add examples for cert-reqs
2023-05-11 10:09:44 +02:00
Benoit Chesneau
f955a0c18c
Merge pull request #2649 from Nordix/sslcontext
Update SSLContext handling
2023-05-11 09:51:37 +02:00
Benoit Chesneau
506d014dd4
Merge pull request #2802 from fdemmer/2801-fix-logrecords
Fix LogRecord pre-formatting, closes #2801
2023-05-08 00:24:18 +02:00
Benoit Chesneau
e6647cf229
Merge pull request #2473 from AlexHill/patch-1 2023-05-07 23:07:53 +02:00
Florian Demmer
0b5c4aea99
Fix LogRecord pre-formatting, closes #2801 2023-05-07 22:46:10 +02:00
Benoit Chesneau
4a1c402e2c
Merge pull request #2384 from larribas/2066-statsd-socket
Allow reporting StatsD metrics over UDS sockets
2023-05-07 20:39:11 +02:00
Benoit Chesneau
db9de0175d
Merge branch 'master' into 1775-support-log-config-json 2023-05-07 16:16:56 +02:00
Tero Saarni
ac8bc3a455 Regenerated rst docs
Signed-off-by: Tero Saarni <tero.saarni@est.tech>
2022-03-15 19:05:30 +02:00
Tero Saarni
6d70be2d1c Merge branch 'master' into sslcontext 2022-03-15 18:55:02 +02:00
Krystian
e5a97150c9
fix chdir documentation typo (#2656) 2022-02-04 08:11:51 +11:00
Tero Saarni
5a581c0b14 Update SSLContext handling
* Change deprecated ssl.wrap_socket() to SSLContext.wrap_context().
* Add new server hook to allow user to create custom SSLContext.
* Updated the documentation.

Signed-off-by: Tero Saarni <tero.saarni@est.tech>
2021-09-12 17:39:06 +03:00
yingjie
0215f5dc36 docs: add examples for cert-reqs 2021-08-26 22:41:12 +08:00
Andrey
daacf39c3f
Improve access-log-format documentation section
Added more clearly info about user name identifier (u). That will save a bit of time for developers due log configuration, like this guy https://stackoverflow.com/questions/51660511/gunicorn-access-logs-shows-empty-user
2021-08-06 10:17:15 +03:00
Daan Luttik
3b8ce3df1f
Added a line to the documentation to further explain the use of logconfig_dict
Added a line to make the question "how to use `logconfig_dict`" way easier to answer.
2021-02-16 15:54:49 -08:00
Adam Johnson
dad99a1bd4 Update gunicorn_ext.py 2021-01-06 03:14:31 +02:00
Adam Johnson
3273492811 Improve settings documentation
I was reading the documentation to configure another application successfully deployed with Gunicorn, and thought the documentation here could be improved a bit for clarity.

* Use code highlighting for the names, to indicate they are the names to use in the Python configuration file.
* Spell out the CLI flags and defaults with "Command line" and "Default" prefixes so it's clear what these are
* Consistently use Python syntax for the defaults, so the types may be more easily understood.
* Split multiple CLI flags with "or" rather than a comma, for clarity and easier copy-paste.
* Improve some descriptions, such as for ``raw_env`` and a header for "Server Hooks".
2021-01-06 03:14:31 +02:00
Alex Hill
d8a1256065
Document that gthread also uses worker_connections
The `ThreadWorker` uses `worker_connections` it in its run loop to limit how many connections are accepted.
2020-12-10 16:10:50 +08:00
Gastón Avila
b80a329354
Correction on default value for config file (#2408)
Running gunicorn project.app while having a file called gunicorn.conf.py
in the current directory will read configuration from that file and actually fail
if the file raises an exception.
2020-08-22 20:13:02 +03:00
larribas
15abac7e81 Allow specifying a UDS socket address through --statsd-host 2020-07-19 20:11:09 +02:00
Dustin Ingram
6aab4decde Add additional missing docs 2020-05-15 03:30:08 +03:00
Randall Leeds
bac7f0300b
Merge pull request #1450 from hramezani/issue_1359
Specify wsgi_app in config
2020-05-03 16:03:07 -07:00
Hasan Ramezni
57a9e2eb7e Specify wsgi_app in config #1359. 2020-05-01 01:11:21 +02:00
Randall Leeds
b2dc036463
Merge pull request #2292 from di/document-infinite-timouts
Document --timeout 0
2020-04-22 11:09:20 -07:00
Randall Leeds
ee685e197b Merge pull request #2054 from rcoup/2052-print-config 2020-04-20 12:40:57 -07:00
Dustin Ingram
57b8cdffae
Document --timeout 0 2020-03-16 17:29:07 -05:00
Randall Leeds
7d8c92f48a
Merge pull request #2253 from kmichel-sereema/2247-document-environment-variables
Document environment variables and $PORT
2020-01-31 09:42:16 -08:00
Kevin Michel
c82996f791 Add documentation for the $PORT environment variable 2020-01-30 15:34:37 +01:00
Anmar85
d307045984
Add milliseconds option to request_time in access_log (#2218)
Add milliseconds option to request_time in access_log
2020-01-30 15:29:25 +01:00
Wojciech Malinowski
5803f835f6 Added a possibility of logging the metrics to a Unix domain socket instead of UDP 2019-06-06 15:13:23 +02:00
Robert Coup
000236aae2 Docs. 2019-05-31 12:22:08 +01:00
Sebastien Williams-Wynn
678b326dc0 Fix typo in --worker-class documentation (#2030) 2019-05-09 21:13:31 +03:00
dblack
96dde54af1 optional datadog tags for statsd metrics 2019-04-27 18:49:47 -07:00
Jat
a1ffebcdb2
worker_connections also affects the Gthread worker type 2019-02-13 22:43:21 +08:00
Daniel Pope
2ea5fbdc86 Use Python's default SSL cipher list by default (#1970) 2019-01-24 22:41:04 +01:00
Brett Randall
c85bfba8b2 Fixed typo in ssl_version doc, TLSv2 -> TLSv1_2 (TLS 1.2). (#1959)
* Fixed typo in ssl_version doc, TLSv2 -> TLSv1_2 (TLS 1.2).

Signed-off-by: Brett Randall <javabrett@gmail.com>

* revert chdir change
2019-01-22 00:03:38 +01:00
Cuong Tran
e98f6a039c added capability to take JSON as log's config 2018-11-18 22:14:54 +00:00
Florian Apolloner
ee7af1247b Added support to --bind to open file descriptors (#1809)
Fixes #1107
2018-11-16 20:21:13 +03:00