Toadfarm - One Mojolicious app to rule them all
0.40
You can start the application by running:
$ toadfarm myconfig.conf;
myconfig.conf should contain a list with the application you want to run and a set of HTTP headers to act on. Example:
myconfig.conf
{ apps => [ 'My::App' => { 'X-Request-Base' => 'http://mydomain.com/whatever', 'config' => { app_config => 123 }, }, '/path/to/my-app' => { 'Host' => 'mydomain.com', }, ], }
The config above will run My::App when the "X-Request-Base" header is set to "http://mydomain.com/whatever".
My::App
Or it will pass the request on to /path/to/my-app if the "Host" header is set to "mydomain.com".
/path/to/my-app
The apps are processed in the order they are defined. This means that the first app that match will be executed.
The application will load the config as you would expect, but it is also possible to override the app config from the toadfarm config. This is especially useful when starting an app installed from cpan:
apps => { # https://metacpan.org/module/App::mojopaste '/usr/local/bin/mojopaste' => { Host => 'p.thorsen.pm', config => { paste_dir => '/some/other/location }, }, },
NOTE! This config will be override the default application config.
It is possible to start the server in foreground as well:
$ MOJO_CONFIG=myconfig.conf toadfarm prefork $ MOJO_CONFIG=myconfig.conf toadfarm daemon
See other options by running:
$ toadfarm -h
This application can be used to load other Mojolicious apps inside one app. This could be useful if you want to save memory or instances on dotcloud or heroku.
Additional config params.
{ apps => [...], # See SYNOPSIS secrets => [qw( super duper unique string )], # See Mojolicious->secrets() log => { file => '/path/to/log/file.log', level => 'debug', # debug, info, warn, ... combined => 1, # true to make all applications log to the same file }, hypnotoad => { listen => ['http://*:1234'], workers => 12, # ... }, paths => { renderer => [ '/my/custom/template/path' ], static => [ '/my/custom/static/path' ], }, plugins => [ MojoPlugin => CONFIG, ], }
log
Used to set up where Toadfarm should log to. It is also possible to set "combined" to true if you want all the other apps to log to the same file.
hypnotoad
See "SETTINGS" in Mojo::Server::Hypnotoad for more "hypnotoad" settings.
paths
Set this to enable custom templates and public files for this application. This is useful if you want your own error templates or serve other assets from Toadfarm.
plugins
"plugins" can be used to load plugins into Toadfarm. The plugins are loaded after the "apps" are loaded. They will receive the CONFIG as the third argument:
CONFIG
sub register { my($self, $app, CONFIG) = @_; # ... }
See also: "SYNOPSIS" in Toadfarm::Plugin::Reload.
Look at https://github.com/jhthorsen/toadfarm/tree/master/etc for example resources which show how to start Toadfarm on ubuntu. In addition, you can forward all traffic to the server using the "iptables" rule below:
$ iptables -A PREROUTING -i eth0 -p tcp -m tcp --dport 80 -j REDIRECT --to-ports 8080
Toadfarm::Plugin::Reload.
This method will read the MOJO_CONFIG and mount the applications specified.
MOJO_CONFIG
Jan Henning Thorsen - jhthorsen@cpan.org
jhthorsen@cpan.org
To install Toadfarm, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Toadfarm
CPAN shell
perl -MCPAN -e shell install Toadfarm
For more information on module installation, please visit the detailed CPAN module installation guide.