Dep on Starman
[catagits/CatalystX-Script-Server-Starman.git] / README
1 NAME
2     CatalystX::Script::Server::Starman - Replace the development server with
3     Starman
4
5 SYNOPSIS
6         myapp_server.pl [options]
7
8            -d --debug           force debug mode
9            -f --fork            handle each request in a new process
10                                 (defaults to false)
11            -? --help            display this help and exits
12            -h --host            host (defaults to all)
13            -p --port            port (defaults to 3000)
14            --follow_symlinks    follow symlinks in search directories
15                                 (defaults to false. this is a no-op on Win32)
16            --background         run the process in the background
17            --pidfile            specify filename for pid file
18            --workers            Initial number of workers to spawn (defaults to 5)
19            --min_servers        Minimum number of worker processes runnning
20            --min_spare_servers  Minimum number of spare workers (more are forked
21                                 if there are less spare than this)
22            --max_spare_servers  Maximum number of spare workers (workers are killed
23                                 if there are more spare than this)
24            --max_servers        Maximum number of workers in total.
25            --max_requests       Maximum number of requests each worker will handle
26            --backlog            Number of backlogged connections allowed
27            --user               User to run as
28            --group              Group to run as
29
30          See also:
31            perldoc Starman
32            perldoc plackup
33            perldoc Catalyst::PSGI
34
35 DESCRIPTION
36     A Catalyst extension to replace the development server with Starman.
37
38     This module replaces the functionality of
39     Catalyst::Engine::HTTP::Prefork, which is now deprecated.
40
41     It provides access to the prefork engine specific options which were
42     previously added by hacking your server script.
43
44 Adding this to your application
45     Just write a server script in your application which inherits from this
46     package.
47
48     For example:
49
50         package MyApp::Script::Server;
51         use Moose;
52         use namespace::autoclean;
53
54         extends 'CatalystX::Script::Server::Starman';
55
56         1;
57
58 SEE ALSO
59     plackup - can be used to start your application ".psgi" under Starman
60
61     Catalyst::PSGI
62
63 AUTHOR
64     Tomas Doran (t0m) "<bobtfish@bobtfish.net"
65
66 COPYRIGHT & LICENSE
67     Copyright 2009 the above author(s).
68
69     This sofware is free software, and is licensed under the same terms as
70     perl itself.
71