Version 0.07

[catagits/Catalyst-Plugin-RequireSSL.git] / lib / Catalyst / Plugin / RequireSSL.pm

diff --git a/lib/Catalyst/Plugin/RequireSSL.pm b/lib/Catalyst/Plugin/RequireSSL.pm
index 1b33bb7..3c65666 100644 (file)
--- a/lib/Catalyst/Plugin/RequireSSL.pm
+++ b/lib/Catalyst/Plugin/RequireSSL.pm
@@ -110,22 +110,29 @@ Catalyst::Plugin::RequireSSL - Force SSL mode on select pages
 =head1 SYNOPSIS
 
     # in MyApp.pm
-    use Catalyst;
-    MyApp->setup( qw/RequireSSL/ );
-    
-    MyApp->config->{require_ssl} = {
-        https => 'secure.mydomain.com',
-        http => 'www.mydomain.com',
-        remain_in_ssl => 0,
-        no_cache => 0,
-        detach_on_redirect => 1,
-    };
+    use Catalyst qw/
+        RequireSSL
+    /;
+    __PACKAGE__->config(
+        require_ssl => {
+            https => 'secure.mydomain.com',
+            http => 'www.mydomain.com',
+            remain_in_ssl => 0,
+            no_cache => 0,
+            detach_on_redirect => 1,
+        },
+    );
+    __PACKAGE__->setup;
+
 
     # in any controller methods that should be secured
     $c->require_ssl;
 
 =head1 DESCRIPTION
 
+B<Note:> This module is considered to be deprecated for most purposes. Consider
+using L<Catalyst::ActionRole::RequireSSL> instead.
+
 Use this plugin if you wish to selectively force SSL mode on some of your web
 pages, for example a user login form or shopping cart.
 
@@ -214,7 +221,8 @@ directly from your web server.
 
 =head1 SEE ALSO
 
-L<Catalyst>, L<Catalyst::Plugin::Static::Simple>
+L<Catalyst>, L<Catalyst::ActionRole::RequireSSL>,
+L<Catalyst::Plugin::Static::Simple>
 
 =head1 AUTHOR