troupe-passport-github

    0.1.7 • Public • Published

    Passport-GitHub

    Passport strategy for authenticating with GitHub using the OAuth 2.0 API.

    This module lets you authenticate using GitHub in your Node.js applications. By plugging into Passport, GitHub authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.

    Install

    $ npm install passport-github
    

    Usage

    Configure Strategy

    The GitHub authentication strategy authenticates users using a GitHub account and OAuth 2.0 tokens. The strategy requires a verify callback, which accepts these credentials and calls done providing a user, as well as options specifying a client ID, client secret, and callback URL.

    passport.use(new GitHubStrategy({
        clientID: GITHUB_CLIENT_ID,
        clientSecret: GITHUB_CLIENT_SECRET,
        callbackURL: "http://127.0.0.1:3000/auth/github/callback"
      },
      function(accessToken, refreshToken, profile, done) {
        User.findOrCreate({ githubId: profile.id }, function (err, user) {
          return done(err, user);
        });
      }
    ));
    

    Authenticate Requests

    Use passport.authenticate(), specifying the 'github' strategy, to authenticate requests.

    For example, as route middleware in an Express application:

    app.get('/auth/github',
      passport.authenticate('github'));
    
    app.get('/auth/github/callback', 
      passport.authenticate('github', { failureRedirect: '/login' }),
      function(req, res) {
        // Successful authentication, redirect home.
        res.redirect('/');
      });
    

    Examples

    For a complete, working example, refer to the login example.

    Tests

    $ npm install --dev
    $ make test
    

    Build Status

    Credits

    License

    The MIT License

    Copyright (c) 2011-2013 Jared Hanson <http://jaredhanson.net/>

    Keywords

    none

    Install

    npm i troupe-passport-github

    DownloadsWeekly Downloads

    5

    Version

    0.1.7

    License

    none

    Last publish

    Collaborators

    • avatar