Skip to content

Latest commit

 

History

History
53 lines (39 loc) · 1.17 KB

README.md

File metadata and controls

53 lines (39 loc) · 1.17 KB
Raw

Opauth-GitHub

Opauth strategy for GitHub authentication.

Implemented based on http://developer.github.com/v3/oauth/ using OAuth2.

Opauth is a multi-provider authentication framework for PHP.

Demo: http://opauth.org/#github

Getting started

  1. Install Opauth-GitHub:

    cd path_to_opauth/Strategy
git clone git://github.com/opauth/github.git GitHub

    or

    composer require opauth/github

  2. Register a GitHub application at https://github.com/settings/applications/new

    • Enter URL as your application URL (this can be outside of Opauth)
    • Callback URL: enter http://path_to_opauth/github/oauth2callback

  3. Configure Opauth-GitHub strategy with client_id and client_secret.

  4. Direct user to http://path_to_opauth/github to authenticate

Strategy configuration

Required parameters:

<?php
'GitHub' => array(
	'client_id' => 'YOUR CLIENT ID',
	'client_secret' => 'YOUR CLIENT SECRET'
)

Optional parameters: scope, state

License

Opauth-GitHub is MIT Licensed
Copyright © 2012 U-Zyn Chua (http://uzyn.com)