Mojolicious - Real-time web framework


  # Application
  package MyApp;
  use Mojo::Base 'Mojolicious';

  # Route
  sub startup {
    my $self = shift;

  # Controller
  package MyApp::Foo;
  use Mojo::Base 'Mojolicious::Controller';

  # Action
  sub hello {
    my $self = shift;
    $self->render_text('Hello World!');


Take a look at our excellent documentation in Mojolicious::Guides!


Mojolicious inherits all attributes from Mojo and implements the following new ones.


  my $class = $app->controller_class;
  $app      = $app->controller_class('Mojolicious::Controller');

Class to be used for the default controller, defaults to Mojolicious::Controller.


  my $mode = $app->mode;
  $app     = $app->mode('production');

The operating mode for your application, defaults to the value of the MOJO_MODE environment variable or development. You can also add per mode logic to your application by defining methods named ${mode}_mode in the application class, which will be called right before startup.

  sub development_mode {
    my $self = shift;

  sub production_mode {
    my $self = shift;

Right before calling startup and mode specific methods, Mojolicious will pick up the current mode, name the log file after it and raise the log level from debug to info if it has a value other than development.


  my $plugins = $app->plugins;
  $app        = $app->plugins(Mojolicious::Plugins->new);

The plugin loader, defaults to a Mojolicious::Plugins object. You can usually leave this alone, see Mojolicious::Plugin if you want to write a plugin or the plugin method below if you want to load a plugin.


  my $renderer = $app->renderer;
  $app         = $app->renderer(Mojolicious::Renderer->new);

Used in your application to render content, defaults to a Mojolicious::Renderer object. The two main renderer plugins Mojolicious::Plugin::EPRenderer and Mojolicious::Plugin::EPLRenderer contain more information.

  # Add another "templates" directory
  push @{$app->renderer->paths}, '/foo/bar/templates';


  my $routes = $app->routes;
  $app       = $app->routes(Mojolicious::Routes->new);

The routes dispatcher, defaults to a Mojolicious::Routes object. You use this in your startup method to define the url endpoints for your application.

  sub startup {
    my $self = shift;

    my $r = $self->routes;


  my $secret = $app->secret;
  $app       = $app->secret('passw0rd');

A secret passphrase used for signed cookies and the like, defaults to the application name which is not very secure, so you should change it!!! As long as you are using the unsecure default there will be debug messages in the log file reminding you to change your passphrase.


  my $sessions = $app->sessions;
  $app         = $app->sessions(Mojolicious::Sessions->new);

Simple signed cookie based sessions, defaults to a Mojolicious::Sessions object. You can usually leave this alone, see "session" in Mojolicious::Controller for more information about working with session data.


  my $static = $app->static;
  $app       = $app->static(Mojolicious::Static->new);

For serving static files from your public directories, defaults to a Mojolicious::Static object.

  # Add another "public" directory
  push @{$app->static->paths}, '/foo/bar/public';


  my $types = $app->types;
  $app      = $app->types(Mojolicious::Types->new);

Responsible for connecting file extensions with MIME types, defaults to a Mojolicious::Types object.

  $app->types->type(twt => 'text/tweet');


Mojolicious inherits all methods from Mojo and implements the following new ones.


  my $app = Mojolicious->new;

Construct a new Mojolicious application. Will automatically detect your home directory and set up logging based on your current operating mode. Also sets up the renderer, static dispatcher and a default set of plugins.


  my $tx = $app->build_tx;

Transaction builder, defaults to building a Mojo::Transaction::HTTP object.


  my $defaults = $app->defaults;
  my $foo      = $app->defaults('foo');
  $app         = $app->defaults({foo => 'bar'});
  $app         = $app->defaults(foo => 'bar');

Default values for "stash" in Mojolicious::Controller, assigned for every new request.

  $app->defaults->{foo} = 'bar';
  my $foo = $app->defaults->{foo};
  delete $app->defaults->{foo};



The heart of every Mojolicious application, calls the static and routes dispatchers for every request and passes them a Mojolicious::Controller object.



Sets up the default controller and calls process for every request.


  $app->helper(foo => sub {...});

Add a new helper that will be available as a method of the controller object and the application object, as well as a function in ep templates.

  # Helper
  $app->helper(add => sub { $_[1] + $_[2] });

  # Controller/Application
  my $result = $self->add(2, 3);

  # Template
  %= add 2, 3


  $app->hook(after_dispatch => sub {...});

Extend Mojolicious with hooks.

  # Dispatchers will not run if there's already a response code defined
  $app->hook(before_dispatch => sub {
    my $c = shift;
    $c->render(text => 'Skipped dispatchers!')
      if $c->req->url->path->contains('/do_not_dispatch');

These hooks are currently available and are emitted in the listed order:


Emitted right after the transaction is built and before the HTTP request gets parsed.

  $app->hook(after_build_tx => sub {
    my ($tx, $app) = @_;

This is a very powerful hook and should not be used lightly, it makes some rather advanced features such as upload progress bars possible, just note that it will not work for embedded applications. (Passed the transaction and application instances)


Emitted right before the static and routes dispatchers start their work.

  $app->hook(before_dispatch => sub {
    my $c = shift;

Very useful for rewriting incoming requests and other preprocessing tasks. (Passed the default controller instance)


Emitted in reverse order after the static dispatcher determined if a static file should be served and before the routes dispatcher starts its work.

  $app->hook(after_static_dispatch => sub {
    my $c = shift;

Mostly used for custom dispatchers and postprocessing static file responses. (Passed the default controller instance)


Emitted in reverse order after a response has been rendered. Note that this hook can trigger before after_static_dispatch due to its dynamic nature.

  $app->hook(after_dispatch => sub {
    my $c = shift;

Useful for all kinds of postprocessing tasks. (Passed the current controller instance)


Emitted right before the before_dispatch hook and wraps around the whole dispatch process, so you have to manually forward to the next hook if you want to continue the chain.

  $app->hook(around_dispatch => sub {
    my ($next, $c) = @_;

This is a very powerful hook and should not be used lightly, consider it the sledgehammer in your toolbox. (Passed a closure leading to the next hook and the current controller instance)


  $app->plugin('some_thing', foo => 23);
  $app->plugin('some_thing', {foo => 23});
  $app->plugin('SomeThing', foo => 23);
  $app->plugin('SomeThing', {foo => 23});
  $app->plugin('MyApp::Plugin::SomeThing', foo => 23);
  $app->plugin('MyApp::Plugin::SomeThing', {foo => 23});

Load a plugin with "register_plugin" in Mojolicious::Plugins.

These plugins are included in the Mojolicious distribution as examples:


Change the application charset.


Perl-ish configuration files.


General purpose helper collection.


Renderer for plain embedded Perl templates.


Renderer for more sophisiticated embedded Perl templates.


Route condition for all kinds of headers.


Internationalization helpers.


JSON configuration files.


Mount whole Mojolicious applications.


Renderer for POD files and documentation browser.


Add an X-Powered-By header to outgoing responses.


Log timing information.


Template specific helper collection.



Start the Mojolicious::Commands command line interface for your application.



This is your main hook into the application, it will be called at application startup.

  sub startup {
    my $self = shift;


In addition to the attributes and methods above you can also call helpers on instances of Mojolicious. This includes all helpers from Mojolicious::Plugin::DefaultHelpers and Mojolicious::Plugin::TagHelpers. Note that application helpers are always called with a new controller_class instance, so they can't depend on or change controller state, which includes request, response and stash.

  $app->log->debug($app->dumper({foo => 'bar'}));




#mojo on





Mojolicious ships with a few popular static files bundled in the public directory.

Mojolicious Artwork

  Copyright (C) 2010-2012, Sebastian Riedel.

Licensed under the CC-SA License, Version 3.0


  Copyright 2011, John Resig.

Licensed under the MIT License,


  Copyright (C) 2006, Google Inc.

Licensed under the Apache License, Version 2.0


Every major release of Mojolicious has a code name, these are the ones that have been used in the past.

2.0, Leaf Fluttering In Wind (u1F343)

1.4, Smiling Face With Sunglasses (u1F60E)

1.3, Tropical Drink (u1F379)

1.1, Smiling Cat Face With Heart-Shaped Eyes (u1F63B)

1.0, Snowflake (u2744)

0.999930, Hot Beverage (u2615)

0.999927, Comet (u2604)

0.999920, Snowman (u2603)


Sebastian Riedel,


Current members of the core team in alphabetical order:

    Abhijit Menon-Sen,

    Glen Hinkle,

    Marcus Ramberg,


In alphabetical order:

    Adam Kennedy

    Adriano Ferreira

    Al Newkirk

    Alex Salimon

    Alexey Likhatskiy

    Anatoly Sharifulin

    Andre Vieth

    Andreas Jaekel

    Andrew Fresh

    Andreas Koenig

    Andy Grundman

    Aristotle Pagaltzis

    Ashley Dev

    Ask Bjoern Hansen

    Audrey Tang

    Ben van Staveren

    Benjamin Erhart

    Bernhard Graf

    Breno G. de Oliveira

    Brian Duggan

    Burak Gursoy

    Ch Lamprecht

    Charlie Brady

    Chas. J. Owens IV

    Christian Hansen


    Curt Tilmes

    Daniel Kimsey

    Danijel Tasov

    David Davis

    Diego Kuperman

    Dmitriy Shalashov

    Dmitry Konstantinov

    Douglas Christopher Wilson

    Eugene Toropov

    Gisle Aas

    Graham Barr

    Henry Tang

    Hideki Yamamura

    James Duncan

    Jan Jona Javorsek

    Jaroslav Muhin

    Jesse Vincent

    Johannes Plunien

    John Kingsley

    Jonathan Yu

    Kazuhiro Shibuya

    Kevin Old

    KITAMURA Akatsuki

    Lars Balker Rasmussen

    Leon Brocard

    Magnus Holm

    Maik Fischer

    Mark Stosberg

    Matthew Lineen

    Maksym Komar

    Maxim Vuets

    Michael Harris

    Mirko Westermeier

    Mons Anderson

    Moritz Lenz

    Neil Watkiss

    Nils Diewald

    Oleg Zhelo

    Pascal Gaudette

    Paul Tomlin

    Pedro Melo

    Peter Edwards

    Pierre-Yves Ritschard

    Quentin Carbonneaux

    Rafal Pocztarski

    Randal Schwartz

    Robert Hicks

    Robin Lee

    Roland Lammel

    Ryan Jendoubi

    Sascha Kiefer

    Sergey Zasenko

    Simon Bertrang

    Simone Tampieri

    Shu Cho

    Skye Shaw

    Stanis Trendelenburg

    Stephane Este-Gracias

    Tatsuhiko Miyagawa

    Terrence Brannon

    The Perl Foundation

    Tomas Znamenacek

    Ulrich Habel

    Ulrich Kautz

    Uwe Voelker

    Viacheslav Tykhanovskyi

    Victor Engmark

    Viliam Pucik

    Wes Cravens

    Yaroslav Korshak

    Yuki Kimoto

    Zak B. Elep


Copyright (C) 2008-2012, Sebastian Riedel.

This program is free software, you can redistribute it and/or modify it under the terms of the Artistic License version 2.0.