Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Documentation tweaks #15

Merged
merged 3 commits into from

2 participants

@melo
Collaborator

Added a couple of tweaks to the documentation, based on my doubts whenever I use Twiggy

melo added some commits
@melo melo Explain how to use the fast HTTP Headers parsing option
Signed-off-by: Pedro Melo <melo@simplicidade.org>
612405f
@melo melo GIve pratical example of Server::Starter usage
Signed-off-by: Pedro Melo <melo@simplicidade.org>
9be58a4
@melo melo Add ENVIRONMENT section explaining TWIGGY_DEBUG
Signed-off-by: Pedro Melo <melo@simplicidade.org>
58f7893
@miyagawa miyagawa merged commit 24c5eb8 into from
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on May 26, 2011
  1. @melo

    Explain how to use the fast HTTP Headers parsing option

    melo authored
    Signed-off-by: Pedro Melo <melo@simplicidade.org>
  2. @melo

    GIve pratical example of Server::Starter usage

    melo authored
    Signed-off-by: Pedro Melo <melo@simplicidade.org>
  3. @melo

    Add ENVIRONMENT section explaining TWIGGY_DEBUG

    melo authored
    Signed-off-by: Pedro Melo <melo@simplicidade.org>
This page is out of date. Refresh to see the latest.
Showing with 27 additions and 2 deletions.
  1. +27 −2 lib/Twiggy.pm
View
29 lib/Twiggy.pm
@@ -51,7 +51,9 @@ renamed to Twiggy. See L</NAMING> for details.
=item Fast header parser
-Uses XS/C based HTTP header parser for the best performance. (optional)
+Uses XS/C based HTTP header parser for the best performance. (optional,
+install the L<HTTP::Parser::XS> module to enable it; see also
+L<Plack::HTTPParser> for more information).
=item Lightweight and Fast
@@ -61,10 +63,33 @@ late 2009.
=item Superdaemon aware
-Supports L<Server::Starter> for hot deploy and graceful restarts.
+Supports L<Server::Starter> for hot deploy and
+graceful restarts.
+
+To use it, instead of the usual:
+
+ plackup --server Twiggy --port 8111 app.psgi
+
+install L<Server::Starter> and use:
+
+ start_server --port 8111 plackup --server Twiggy app.psgi
+
+=back
+
+
+=head1 ENVIRONMENT
+
+The following environment variables are supported.
+
+=over 4
+
+=item TWIGGY_DEBUG
+
+Set to true to enable debug messages from Twiggy.
=back
+
=head1 NAMING
=head2 Twiggy?
Something went wrong with that request. Please try again.