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