periodicjs.ext.login
Version:
An authentication extension for periodicjs that uses passport to authenticate user sessions.
85 lines (50 loc) • 2.78 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Index</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Index</h1>
<h3> </h3>
<section>
<article><h1>periodicjs.ext.login</h1>
<p>An authentication extension that uses passport to authenticate user sessions.</p>
<p> <a href="https://github.com/typesettin/periodicjs.ext.login/blob/master/doc/api.md">API Documentation</a></p>
<h2>Installation</h2>
<pre><code>$ npm install periodicjs.ext.login</code></pre>
<h2>Configure</h2>
<p>you can define your own passort authentication strategies, after the extension has been installed, the extension configuration is located in <code>content/config/extensions/periodicjs.ext.login/transport.json</code></p>
<h2>Development</h2>
<p><em>Make sure you have grunt installed</em></p>
<pre><code>$ npm install -g grunt-cli</code></pre>
<p>Then run grunt watch</p>
<pre><code>$ grunt watch</code></pre>
<p>For generating documentation</p>
<pre><code>$ grunt doc
$ jsdoc2md controller/**/*.js index.js install.js uninstall.js > doc/api.md</code></pre>
<h2>Notes</h2>
<ul>
<li>Check out <a href="https://github.com/typesettin/periodicjs">https://github.com/typesettin/periodicjs</a> for the full Periodic Documentation</li>
</ul></article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-authController.html">authController</a></li><li><a href="module-userloginController.html">userloginController</a></li><li><a href="login.html">login</a></li></ul><h3>Global</h3><ul><li><a href="global.html#facebook">facebook</a></li><li><a href="global.html#facebookcallback">facebookcallback</a></li><li><a href="global.html#instagram">instagram</a></li><li><a href="global.html#instagramcallback">instagramcallback</a></li><li><a href="global.html#saveUser">saveUser</a></li><li><a href="global.html#twitter">twitter</a></li><li><a href="global.html#twittercallback">twittercallback</a></li><li><a href="global.html#usePassport">usePassport</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Thu Jan 29 2015 21:18:44 GMT-0500 (EST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>