NAME
Starman - High-performance preforking PSGI/Plack web server
SYNOPSIS
# Run app.psgi with the default settings> starman# run with Server::Starter> start_server --port 127.0.0.1:80 -- starman --workers 32 myapp.psgi# UNIX domain sockets> starman --listen /tmp/starman.sock
Read more options and configurations by running `perldoc starman` (lower-case s).
DESCRIPTION
Starman is a PSGI perl web server that has unique features such as:
- High Performance
Uses the fast XS/C HTTP header parser
- Preforking
Spawns workers preforked like most high performance UNIX servers do. Starman also reaps dead children and automatically restarts the worker pool.
- Signals
Supports
HUP
for graceful worker restarts, andTTIN
/TTOU
to dynamically increase or decrease the number of worker processes, as well asQUIT
to gracefully shutdown the worker processes.- Superdaemon aware
SupportsServer::Starter for hot deploy and graceful restarts.
- Multiple interfaces and UNIX Domain Socket support
Able to listen on multiple interfaces including UNIX sockets.
- Small memory footprint
Preloading the applications with
--preload-app
command line option enables copy-on-write friendly memory management. Also, the minimum memory usage Starman requires for the master process is 7MB and children (workers) is less than 3.0MB.- PSGI compatible
Can run any PSGI applications and frameworks
- HTTP/1.1 support
Supports chunked requests and responses, keep-alive and pipeline requests.
- UNIX only
This server does not support Win32.
PERFORMANCE
Here's a simple benchmark usingHello.psgi
.
-- server: Starman (workers=10)Requests per second: 6849.16 [#/sec] (mean)-- server: TwiggyRequests per second: 3911.78 [#/sec] (mean)-- server: AnyEvent::HTTPDRequests per second: 2738.49 [#/sec] (mean)-- server: HTTP::Server::PSGIRequests per second: 2218.16 [#/sec] (mean)-- server: HTTP::Server::PSGI (workers=10)Requests per second: 2792.99 [#/sec] (mean)-- server: HTTP::Server::SimpleRequests per second: 1435.50 [#/sec] (mean)-- server: CoronaRequests per second: 2332.00 [#/sec] (mean)-- server: POERequests per second: 503.59 [#/sec] (mean)
This benchmark was processed withab -c 10 -t 1 -k
on MacBook Pro 13" late 2009 model on Mac OS X 10.6.2 with perl 5.10.0. YMMV.
NOTES
Because Starman runs as a preforking model, it is not recommended to serve the requests directly from the internet, especially when slow requesting clients are taken into consideration. It is suggested to put Starman workers behind the frontend servers such as nginx, and use HTTP proxy with TCP or UNIX sockets.
PSGI EXTENSIONS
psgix.informational
Starman exposes a callback namedpsgix.informational
that can be used for sending an informational response. The callback accepts two arguments, the first argument being the status code and the second being an arrayref of the headers to be sent. Example below sends an 103 Early Hints response before processing the request to build a final response.
sub { my $env = shift; $env->{'psgix.informational'}->( 103, [ "Link" => "</style.css>; rel=preload" ] ); my $rest = ... $resp;}
AUTHOR
Tatsuhiko Miyagawa <miyagawa@bulknews.net>
Andy Grundman wroteCatalyst::Engine::HTTP::Prefork, which this module is heavily based on.
Kazuho Oku wroteNet::Server::SS::PreFork that makes it easy to addServer::Starter support to this software.
Thepsgix.informational
callback comes fromStarlet by Kazuho Oku.
COPYRIGHT
Tatsuhiko Miyagawa, 2010-
LICENSE
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
SEE ALSO
Module Install Instructions
To install Starman, copy and paste the appropriate command in to your terminal.
cpanm Starman
perl -MCPAN -e shellinstall Starman
For more information on module installation, please visitthe detailed CPAN module installation guide.