root/lang/perl/Apache2-AuthHatena/trunk/README @ 11425

Revision 11425, 2.0 kB (checked in by lopnor, 7 years ago)

lang/perl/Apache2-AuthHatena?: first import

Line 
1NAME
2    Apache2::AuthHatena - Simple authentication mod_perl module using Hatena
3    Auth API
4
5SYNOPSIS
6      LoadModule perl_module modules/mod_perl.so
7      PerlLoadModule Apache2::AuthHatena
8
9      AuthType Hatena
10      AuthName "My private documents"
11      HatenaAuthKey yourauthkeygoeshere
12      HatenaAuthSecret youauthsecretgoeshere
13      HatenaAuthCallback http://sample.com/path/to/callback
14      require valid-user
15
16DESCRIPTION
17    This mod_perl module allows you to implement easy authentication with
18    Hatena Authentication API. You need Hatena Authentication API key from
19    <http://auth.hatena.ne.jp>.
20
21    Add the folloing lines to you Apache configuration file to load this
22    module:
23
24      LoadModule perl_module modules/mod_perl.so
25      PerlLoadModule Apache2::AuthHatena
26
27    And then you can write .htaccess file like this:
28
29      AuthType Hatena
30      AuthName "My private documents"
31      HatenaAuthKey yourauthkeygoeshere
32      HatenaAuthSecret youauthsecretgoeshere
33      HatenaAuthCallback http://sample.com/path/to/callback
34      require valid-user
35
36    AuthType must be "hatena", and each of HatenaAuthKey, HatenaAuthSecret,
37    and HatenaAuthCallback should be the value you've got from
38    <http://auth.hatena.ne.jp>. If you assign 'valid-user' to 'require'
39    directive, it means all people who has Hatena ID can see the protected
40    documents. When you want to show the document only to, for example,
41    id:jkondo and id:naoya, you can write like this:
42
43      require user jkondo naoya
44
45COMPATIBILITY
46    This module will only work with mod_perl2. mod_perl1 is not supported.
47
48SEE ALSO
49    Hatena::API::Auth <http://auth.hatena.ne.jp>
50
51AUTHOR
52    Nobuo Danjou, danjou@hatena.ne.jp
53
54COPYRIGHT AND LICENSE
55    Copyright (C) 2007 by Nobuo Danjou
56
57    This library is free software; you can redistribute it and/or modify it
58    under the same terms as Perl itself, either Perl version 5.8.6 or, at
59    your option, any later version of Perl 5 you may have available.
60
Note: See TracBrowser for help on using the browser.