dani/lemonldap-ng
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc: add Twitter documentation

Browse Source
This commit is contained in:
Clément Oudot 2010-03-15 13:31:33 +00:00
parent 07d64f8c82
commit 8c44683977
6 changed files with 133 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
build/lemonldap-ng/doc/3-Table-of-contents-fr.html
View File

@ -264,6 +264,9 @@
<li><span class="wikilink"><a href=
"4.5-OpenID-authentication-backend.html">OpenID</a></span> (en)</li>
<li><span class="wikilink"><a href=
"4.5-Twitter-authentication-backend.html">Twitter</a></span> (en)</li>
</ul>
<h4 class="heading-1-1-1"><span id="HBased27utilisateurs">Base

3
build/lemonldap-ng/doc/3-Table-of-contents.html
View File

@ -256,6 +256,9 @@
<li><span class="wikilink"><a href=
"4.5-OpenID-authentication-backend.html">OpenID</a></span> (en)</li>
<li><span class="wikilink"><a href=
"4.5-Twitter-authentication-backend.html">Twitter</a></span> (en)</li>
</ul>
<h4 class="heading-1-1-1"><span id="HUserdatabasebackends">User database

14
build/lemonldap-ng/doc/4.1-Configuration-parameter-list.html
View File

@ -2226,7 +2226,7 @@ level1Key =&gt; { level2Key =&gt; 'value' },
<td>twitterKey</td>
<td>0.9.5</td>
<td>1.0</td>
<td>No*</td>
</tr>
@ -2236,7 +2236,17 @@ level1Key =&gt; { level2Key =&gt; 'value' },
<td>twitterSecret</td>
<td>0.9.5</td>
<td>1.0</td>
<td>No*</td>
</tr>
<tr class="table-odd">
<td>twitter application name</td>
<td>twitterAppName</td>
<td>1.0</td>
<td>No*</td>
</tr>

112
build/lemonldap-ng/doc/4.5-Twitter-authentication-backend.html Normal file
View File

@ -0,0 +1,112 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="fr" xml:lang="fr">
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org" />
<title>Lemonldap::NG documentation:
4.5-Twitter-authentication-backend.html</title>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
<style type="text/css">
/*<![CDATA[*/
body{
background: #ddd;
font-family: sans-serif;
font-size: 11pt;
padding: 0 50px;
}
div.main-content{
padding: 10px;
background: #fff;
border: 2px #ccc solid;
}
a{
text-decoration: none;
}
p.footer{
text-align: center;
margin: 5px 0 0 0;
}
.heading-1{
text-align: center;
color: orange;
font-variant: small-caps;
font-size: 20pt;
}
.heading-1-1{
color: orange;
font-size: 14pt;
border-bottom: 2px #ccc solid;
}
pre{
background: #eee;
border: 2px #ccc solid;
padding: 5px;
border-left: 10px #ccc solid;
}
ul.star li{
list-style-type: square;
}
/*]]>*/
</style>
</head>
<body>
<div class="main-content">
<h2 class="heading-1"><span id="HTwitter">Twitter</span></h2>
<p class="paragraph"></p>
<ul>
<li><a href="#HPresentation">Presentation</a></li>
<li><a href="#HLemonLDAP3A3ANGconfiguration">LemonLDAP::NG
configuration</a></li>
</ul>
<h3 class="heading-1-1"><span id="HPresentation">Presentation</span></h3>
<p class="paragraph"></p>Twitter is a famous online short messaging
server, see <span class="wikiexternallink"><a href=
"http://twitter.com">http://twitter.com</a></span>. Twitter use OAuth
protocol to allows applications to reuse its own authentication process
(it means, if your are connected to twitter, other applications can trust
twitter and let you in).
<p class="paragraph"></p>You need perl Net::Twitter package, with a very
recent version (&gt;3). You can find i on CPAN: <span class=
"wikiexternallink"><a href=
"http://search.cpan.org/~mmims/Net-Twitter/">http://search.cpan.org/~mmims/Net-Twitter/</a></span>.
<p class="paragraph"></p>You need to regsiter a new application on Twitter
to get API key and API secret. See Twitter FAQ on how to do that:
<span class="wikiexternallink"><a href=
"http://apiwiki.twitter.com/FAQ#HowdoIget%E2%80%9CfromMyApp%E2%80%9DappendedtoupdatessentfrommyAPIapplication">
http://apiwiki.twitter.com/FAQ#HowdoIget%E2%80%9CfromMyApp%E2%80%9DappendedtoupdatessentfrommyAPIapplication</a></span>.
<h3 class="heading-1-1"><span id=
"HLemonLDAP3A3ANGconfiguration">LemonLDAP::NG configuration</span></h3>
<p class="paragraph"></p>Just set API key and API secret in LemonLDAP::NG
configuration. You can also set Application Name (by default:
Lemonldap::NG).
<p class="paragraph"></p>For example:
<div class="code">
<pre>
authentication =&gt; 'Twitter',
userDB =&gt; 'Null', # Do not use userDB
twitterKey =&gt; 'hdODNci354n',
twitterSecret =&gt; 'Jdldc1e1ce31661EEC16eCS22ee1tbt8',
twitterAppName =&gt; 'My marvelous application',
</pre>
</div>
</div>
<p class="footer"><a href="index.html">Index</a></p>
</body>
</html>

1
build/lemonldap-ng/doc/index.html
View File

@ -85,6 +85,7 @@
<li><a href="4.5-Remote-authentication-backend.html">4.5 Remote authentication backend</a></li>
<li><a href="4.5-SAML-authentication-backend.html">4.5 SAML authentication backend</a></li>
<li><a href="4.5-SSL-authentication-backend.html">4.5 SSL authentication backend</a></li>
<li><a href="4.5-Twitter-authentication-backend.html">4.5 Twitter authentication backend</a></li>
<li><a href="4.6-LDAP-user-backend.html">4.6 LDAP user backend</a></li>
<li><a href="4.6-Multiple-user-backend.html">4.6 Multiple user backend</a></li>
<li><a href="4.6-Null-user-backend.html">4.6 Null user backend</a></li>

2
build/lemonldap-ng/scripts/doc.pl
View File

@ -50,6 +50,7 @@ my $docs = {
'http://wiki.lemonldap.ow2.org/xwiki/bin/view/NG/AuthSAML' => '4.5-SAML-authentication-backend.html',
'http://wiki.lemonldap.ow2.org/xwiki/bin/view/NG/DocLA?language=fr' => '4.5-Liberty-Alliance-authentication-backend-fr.html',
'http://wiki.lemonldap.ow2.org/xwiki/bin/view/NG/AuthOpenID' => '4.5-OpenID-authentication-backend.html',
'http://wiki.lemonldap.ow2.org/xwiki/bin/view/NG/AuthTwitter' => '4.5-Twitter-authentication-backend.html',
# User backends
'http://wiki.lemonldap.ow2.org/xwiki/bin/view/NG/UserDBLDAP' => '4.6-LDAP-user-backend.html',
'http://wiki.lemonldap.ow2.org/xwiki/bin/view/NG/UserDBNull' => '4.6-Null-user-backend.html',
@ -223,6 +224,7 @@ while ( my ( $url, $file ) = each %$docs ) {
s#/xwiki/bin/view/NG/AuthMulti#4.5-Multiple-authentication-backend.html#g;
s#/xwiki/bin/view/NG/AuthSAML#4.5-SAML-authentication-backend.html#g;
s#/xwiki/bin/view/NG/AuthOpenID#4.5-OpenID-authentication-backend.html#g;
s#/xwiki/bin/view/NG/AuthTwitter#4.5-Twitter-authentication-backend.html#g;
s#/xwiki/bin/view/NG/UserDBLDAP#4.6-LDAP-user-backend.html#g;
s#/xwiki/bin/view/NG/UserDBNull#4.6-Null-user-backend.html#g;
s#/xwiki/bin/view/NG/UserDBMulti#4.6-Multiple-user-backend.html#g;