GUNICORN_PASTER(1)

🌈 GUNICORN_PASTER(1) ✨

okay bestie, welcome to the gunicorn_paster page 💅 this is a User Contributed Perl Documentation joint, and it's about the Paste application entry-point flavor of gunicorn. buckle up, it's giving server-core 🦋

---

🌸 NAME 🌸

gunicorn_paster — an event-based HTTP/WSGI server, specifically the Paste application entry-point. no cap, that's literally what it is 🫶

---

🎀 SYNOPSIS 🎀

gunicorn_paster [OPTIONS] [SETTINGS_PATH]

like... options first, then your settings path, mwah 💖

---

✨ OPTIONS ✨

every single one of these, no skipping, we don't do that here 👑

• -c CONFIG, --config=CONFIG — the config file. default is [none], so like, none 🫠
• -b BIND, --bind=BIND — the address to listen on. e.g. 127.0.0.1:8000 or unix:/tmp/gunicorn.sock 🔥
• -w WORKERS, --workers=WORKERS — how many workers to spawn. default [1] — yes, just one, humble of her 💜
• -a ARBITER, --arbiter=ARBITER — the gunicorn arbiter entry point or module. default [egg:gunicorn#main] 🌸
• -p PIDFILE, --pid=PIDFILE — set the background PID FILE 📌
• -D, --daemon — run daemonized, in the background, living her life 🦋
• -m UMASK, --umask=UMASK — define the umask of the daemon process 🔐
• -u USER, --user=USER — change the worker user 👤
• -g GROUP, --group=GROUP — change the worker group 👥
• -n PROC_NAME, --name=PROC_NAME — process name 🏷️
• --log-level=LOGLEVEL — log level below which messages get silenced. default [info] 🤫
• --log-file=LOGFILE — log to a file. - equals stdout. default [-] 📝
• d, --debug — debug mode. only 1 worker. (yes, the original literally writes it as d, we are being faithful, don't come for me 😭)
• --version — show the program's version number and exit 👋
• -h, --help — show this help message and exit 🫶

---

💖 DESCRIPTION 💖

Green Unicorn (gunicorn) is an HTTP/WSGI server built to serve fast clients or sleepy applications. and what that means is: it lives behind a buffering front-end server, like nginx or lighttpd. periodt 💅

• Optional support for Eventlet and Gevent so you get asynchronous long-polling ("Comet") connections ⚡
• Process management: Gunicorn reaps and restarts workers that die. it's giving main character energy, she's not letting anyone ghost 👑
• Easy integration with Django and Paster compatible applications (Pylons, TurboGears 2, etc. 🐍
• Load balancing via pre-fork and a shared socket ⚖️
• Graceful worker process restarts 🕊️
• Upgrading without losing connections ✨
• Decode chunked transfers on-the-fly, which allows upload progress notifications or stream-based protocols over HTTP 📡

---

🧚 TUNING 🧚

🔧 KERNEL PARAMETERS 🔧

there are various kernel parameters you might wanna tune to deal with a large number of simultaneous connections. ngl, these generally only affect sites with a large number of concurrent requests, and they apply to any sort of network server you may be running. they're listed here purely for ease of reference, iykyk 📚

⚠️ the commands listed are tested under Mac OS X 10.6. your flavor of Unix may use slightly different flags. always reference the appropriate man pages if you're uncertain, bestie, don't guess 🙈

🌟 INCREASING THE FILE DESCRIPTOR LIMIT 🌟

one of the first settings that usually needs a bump is the max number of open file descriptors for a given process. and for the confused ones out there — remember, Unices treat sockets as files. they're the same thing, fr fr 💀

$ sudo ulimit -n 1024

🌊 INCREASING THE LISTEN QUEUE SIZE 🌊

listening sockets have an associated queue of incoming connections that are waiting to be accepted. if you get a whole stampede of clients that fill up this queue, new connections will eventually start getting dropped. tragic 😭

$ sudo sysctl -w kern.ipc.somaxconn="1024"

🦋 WIDENING THE EPHEMERAL PORT RANGE 🦋

after a socket is closed it eventually enters the TIME_WAIT state. this can become an issue after a prolonged burst of client activity. eventually the ephemeral port range is used up, which can cause new connections to stall while they wait for a valid port 😵

🍓 this setting is generally only required on machines that are being used to test a network server. so like, lab vibes only 🧪

---

👀 SEE ALSO 👀

• gunicorn(1) — go read that one too, bestie 💜

---

and that's the whole page, you ate that 🎀✨ this was GUNICORN_PASTER(1), from perl v5.38.2, dated 2024-08-14. mwah, go run your server 💅🫶