[DRE-commits] r1281 - packages-wip/mongrel/trunk/debian

[Filipe Lautert]

Author: filipe-guest
Date: 2007-02-06 19:14:49 +0100 (Tue, 06 Feb 2007)
New Revision: 1281

Modified:
   packages-wip/mongrel/trunk/debian/mongrel.1
Log:

Changed documentation for mongrel configuration.



Modified: packages-wip/mongrel/trunk/debian/mongrel.1
===================================================================
--- packages-wip/mongrel/trunk/debian/mongrel.1	2007-02-06 17:50:15 UTC (rev 1280)
+++ packages-wip/mongrel/trunk/debian/mongrel.1	2007-02-06 18:14:49 UTC (rev 1281)
@@ -1,10 +1,4 @@
-.\"                                      Hey, EMACS: -*- nroff -*-
-.\" First parameter, NAME, should be all caps
-.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
-.\" other parameters are allowed: see man(7), man(1)
 .TH MONGREL 1 "Juni 28, 2006"
-.\" Please adjust this date whenever revising the manpage.
-.\"
 .\" Some roff macros, for reference:
 .\" .nh        disable hyphenation
 .\" .hy        enable hyphenation
@@ -22,34 +16,58 @@
 .RI {start | stop | reload | restart} 
 [application_name]
 .SH DESCRIPTION
-\fB/etc/init.d/mongrel\fP can control any number of Rails applications running under the Mongrel webserver. Pen will be used to balance load between multiple Mongrel processes. 
+\fB/etc/init.d/mongrel\fP can control any number of Rails applications running under the Mongrel webserver. Pen will be used to balance load between multiple Mongrel processes when needed.
 .SH CONFIGURATION
 Each application is configured with a file located in (or symlinked to)
 \fB/etc/mongrel/sites-enabled\fP. The name of such a file can be given 
 as a second argument to the script, to only apply the stop/start/restart 
 command to this application.
 .PP
-Each config file has to set the following variables:
+The file is a YAML that uses the same variables that \fBmongrel_rails\fP (1), just adding the following optional variables to control pen:
+.PP
+\fB:pen_status_file\fP        pen status file
 .br
-\fBdir\fP        base directory of your Rails application (RAILS_HOME)
+\fB:additional_pen_opts\fP    additional options passed to pen
 .br
-\fBport\fP       base port for Mongrel to use
+\fB:proxy_port\fP             port for the pen proxy server to listen for inbound connections. You should configure your frontend Web server (e.g. Apache) to forward requests for your application to this port.
+.PP
+A simple configuration file looks like:
 .br
-\fBservers\fP    number of servers to start. Each server will take it's own port, counting upwards from \fBport\fP.
+:user:
 .br
-.PP
-The following variables are optional:
+:log_file: /var/log/mongrel/example.log
 .br
-\fBenv\fP                    environment the application shall run. If it isn't set, will default to production.
+:group:
 .br
-\fBbind_address\fP           ip address to bind. If not set, will default to 127.0.0.1.
+:debug: false
 .br
-\fBpen_status_file\fP        pen status file.
+:prefix:
 .br
-\fBadditional_pen_opts\fP    additional options passed to pen.
+:pid_file: /var/run/mongrel/example.pid
 .br
-\fBproxy_port\fP             port for the pen proxy server to listen for inbound connections. You should configure your frontend Web server (e.g. Apache) to forward requests for your application to this port.
+:includes:
 .br
+:config_file:
+.br
+:environment: development
+.br
+:config_script:
+.br
+:host: 0.0.0.0
+.br
+:docroot: public
+.br
+:num_processors: 1024
+.br
+:port: 3000
+.br
+:mime_map:
+.br
+:timeout: 0
+.br
+:cwd: /var/www/path/to/app
+.br
+:daemon: false
 .PP
 .SH SEE ALSO
 .BR pen (1), mongrel_rails (1)
@@ -57,3 +75,4 @@
 .SH AUTHOR
 Mongrel (http://mongrel.rubyforge.org/) was written by Zed Shaw.
 The init script and this man page were written by Jens  Krämer <jk at jkraemer.net>.
+It might be used and redistributed under the same terms as the program itself.