Common Config Options

For config file styles that don't support multiple values for a single option, you can use a comma-separated string to set multiple options.

server

This will be passed to the "plackup" command to tell it what server class to use, for example Starlet or Corona. If you specify "Starman", then the "starman" command will be used instead of "plackup".

You can also use the value "plackup" here, which will let the Plack code pick the server automagically.

This is required.

builder

The code builder to use. Currently, this can be one of Catalyst, Mason, Mojo, or FromTemplate. Each code builder support different config options. See below for details.

pid_file

The location of the pid file for this application.

This is required.

include

A set of include directories to be passed to "plackup". You can specify multiple values.

modules

A set of modules to be passed to "plackup". You can specify multiple values. These modules will be preloaded by "plackup".

listen

This can be "HOST", "HOST:PORT", ":PORT", or a path for a Unix socket. This can be set multiple times, but some servers may not support multiple values.

user

If this is set then Emplacken will attempt to become this user before starting the PSGI app.

group

If this is set then Emplacken will attempt to become this group before starting the PSGI app.

middleware

This can be one or more middleware modules that should be enabled. Note that there is no way to pass config options to these modules (yet?). You can specify multiple values.

reverse_proxy

If this is true, then the Plack::Middleware::ReverseProxy module is enabled for requests coming from 127.0.0.1.

access_log

If this is set to a file, then the Plack::Middleware::AccessLog module is enabled. It will log to the specified file.

access_log_format

This can be used to change the access log format.

error_log

If this is set, then the generated PSGI app will tie "STDERR" and log to a file. The log format is like Apache's error log, so you'll get something like this:

  [Sun Dec 19 00:42:32 2010] [error] [client 1.2.3.4] Some error

Any error output from Perl will be tweaked so that it fits on a single line. All non-printable characters will be replaced by their hex value.

Starman Options

workers

The number of worker processes to spawn.

backlog

The maximum number of backlogged listener sockets allowed.

max_requests

The maximum number of requests per child.

preload_app

If this is true, then your PSGI app is preloaded by Starman before any child processes are forked.

disable_keepalive

If this is true, then keepalive is disabled.

Catalyst Options

Mason Options

Mojo Options

FromTemplate

Template Variables

You should design your template to expect several variables:

• {{$modules}}

  This will be a set of "use" statements loading any needed modules. This will include modules specified in the "modules" config key, and well as additional modules Emplacken may require in your PSGI application file.

• {{$pre}}

  This will be a chunk of code that should come before any setup code you need to write, and before the "builder" block.

• {{$builder_pre}}

  This should go immediately inside your "builder" block.

• {{$mw}}

  This will be a chunk of code that enables middleware. It will include middleware specified by the "middleware" config option as well as anything else Emplacken needs (like the access log code).

• {{$post}}

  This will be a chunk of code that should come after the "builder" block at the end of the file.

Here is an example template for a Catalyst application called "MyApp":

  use strict;
  use warnings;

  use MyApp;
  {{$modules}}
  {{$pre}}

  MyApp->setup_engine('PSGI');

  builder {
      {{ $builder_pre }}
      {{ $mw }}
      sub { MyApp->run(@_) };
  };

  {{$post}}