Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 265 lines (216 sloc) 10.81 kb
7d87c5e @uzyn Opauth logo
authored
1 ![Opauth](https://github.com/uzyn/opauth.org/raw/master/images/opauth-logo-300px-transparent.png)
2 =================================
c207b3a @uzyn Opauth readme update
authored
3 Opauth is a multi-provider authentication framework for PHP, inspired by [OmniAuth for Ruby](https://github.com/intridea/omniauth).
4
1b78167 @uzyn Removed "DO NOT USE" in README
authored
5 Opauth enables PHP applications to do *user authentication* with ease.
6
2945d4c @uzyn Insert a link to opauth.org
authored
7 Try out Opauth for yourself at http://opauth.org
8
bc572b4 @uzyn Added Travis build status
authored
9 [![Build Status](https://secure.travis-ci.org/uzyn/opauth.png?branch=master)](http://travis-ci.org/uzyn/opauth)
10
c207b3a @uzyn Opauth readme update
authored
11 What is Opauth?
ef207b9 @uzyn Markdowned README
authored
12 ---------------
436fb98 @uzyn 0.4.4 release changelog. #41
authored
13 Opauth provides a standardized method for PHP applications to interface with authentication providers.
c207b3a @uzyn Opauth readme update
authored
14
2e81654 @uzyn Updated with quick start, support channels, etc
authored
15 Opauth as a framework provides a set of API that allows developers to [create strategies](https://github.com/uzyn/opauth/wiki/Strategy-Contribution-Guide) that work in a predictable manner across PHP frameworks and applications.
a9fa025 @uzyn formatting
authored
16
4b21625 @uzyn Minor grammatical update
authored
17 Opauth works well with other PHP applications & frameworks. It is currently supported on:
1c8c6e1 @uzyn Added mcatm's CodeIgniter plugin
authored
18
a1266a4 @uzyn Added FakeHeal's Laravel plugin.
authored
19 - [vanilla (plain) PHP applications](https://github.com/uzyn/opauth/tree/master/example)
1c8c6e1 @uzyn Added mcatm's CodeIgniter plugin
authored
20 - [CakePHP](https://github.com/uzyn/cakephp-opauth) (maintained by [uzyn](https://github.com/uzyn))
11b2c3f @uzyn Listing another CodeIgniter plugin. Closes #9
authored
21 - [CodeIgniter](https://github.com/destinomultimedia/ci_opauth) (maintained by [destinomultimedia](https://github.com/destinomultimedia))
1c8c6e1 @uzyn Added mcatm's CodeIgniter plugin
authored
22 - [CodeIgniter](https://github.com/mcatm/Opauth-Plugin-for-Codeigniter) (maintained by [mcatm](https://github.com/mcatm))
9ce3736 @uzyn Added andreoav's FuelPHP framework
authored
23 - [FuelPHP](https://github.com/andreoav/fuel-opauth) (maintained by [andreoav](https://github.com/andreoav/))
a1266a4 @uzyn Added FakeHeal's Laravel plugin.
authored
24 - [Laravel](https://github.com/FakeHeal/opauth-laravel) (maintained by [FakeHeal](https://github.com/FakeHeal/))
25 - [PrestaShop](https://github.com/Onasusweb/PrestaShop-Opauth) (maintained by [Onasusweb](https://github.com/Onasusweb))
c7e10af @uzyn Added Silex plugin and Bitbucket strategy.
authored
26 - [Silex](https://github.com/icehero/silex-opauth) (maintained by [icehero](https://github.com/icehero/))
436fb98 @uzyn 0.4.4 release changelog. #41
authored
27 - [SilverStripe](https://github.com/BetterBrief/silverstripe-opauth) (maintained by [Better Brief](https://github.com/BetterBrief))
1c8c6e1 @uzyn Added mcatm's CodeIgniter plugin
authored
28 - [Yii Framework](https://github.com/kahwee/yii-opauth) (maintained by [kahwee](https://github.com/kahwee))
bddffca @uzyn Added plugin for Zend Framework 2.
authored
29 - [Zend Framework 2](https://github.com/lorenzoferrarajr/LfjOpauth) (maintained by [lorenzoferrarajr](https://github.com/lorenzoferrarajr))
436fb98 @uzyn 0.4.4 release changelog. #41
authored
30 - and more to come.
06f5e91 @uzyn Main README with more in-depth steps
authored
31
32 If your PHP framework of choice is not yet listed, you can still use Opauth like you would a normal PHP component (class).
c207b3a @uzyn Opauth readme update
authored
33
2e81654 @uzyn Updated with quick start, support channels, etc
authored
34 Quick start
35 -----------
cddea81 @uzyn Quick start guide updated
authored
36 Guide on how to run the bundled example.
37
436fb98 @uzyn 0.4.4 release changelog. #41
authored
38 1. Set `DocumentRoot` of your web server to `example/`.
2e81654 @uzyn Updated with quick start, support channels, etc
authored
39 (Opauth can be instantiated in your own PHP app, but we will leave that out of this quick start guide)
40
06f5e91 @uzyn Main README with more in-depth steps
authored
41 2. Configure Opauth.
42
436fb98 @uzyn 0.4.4 release changelog. #41
authored
43 First, make a copy of opauth config's file by copying or renaming
06f5e91 @uzyn Main README with more in-depth steps
authored
44 `opauth.conf.php.default` to `opauth.conf.php`.
2e81654 @uzyn Updated with quick start, support channels, etc
authored
45
06f5e91 @uzyn Main README with more in-depth steps
authored
46 Open up `opauth.conf.php` and make the necessary changes.
2e81654 @uzyn Updated with quick start, support channels, etc
authored
47
436fb98 @uzyn 0.4.4 release changelog. #41
authored
48 3. Install some [Opauth strategies](https://github.com/uzyn/opauth/wiki/List-of-strategies).
49 Place the strategy files in `lib/Opauth/Strategy/`.
cddea81 @uzyn Quick start guide updated
authored
50
06f5e91 @uzyn Main README with more in-depth steps
authored
51 For this example, we recommend that you start with [Opauth-Facebook](https://github.com/uzyn/opauth-facebook):
52
53 i. [Download the strategy files](https://github.com/uzyn/opauth-facebook/zipball/master) and place them at `lib/Opauth/Strategy/Facebook/`.
54
55 ii. Follow the steps at [Opauth-Facebook's README](https://github.com/uzyn/opauth-facebook/blob/master/README.md) to set up your Faceobok app.
56
436fb98 @uzyn 0.4.4 release changelog. #41
authored
57 iii. Add the following at `opauth.conf.php` under `Strategy` as such:
06f5e91 @uzyn Main README with more in-depth steps
authored
58
59 ```php
60 <?php
436fb98 @uzyn 0.4.4 release changelog. #41
authored
61 'Strategy' => array(
06f5e91 @uzyn Main README with more in-depth steps
authored
62 // Define strategies here.
63
64 'Facebook' => array(
65 'app_id' => 'YOUR APP ID',
66 'app_secret' => 'YOUR APP SECRET'
67 ),
68 );
69 ```
70
71 Finally, send user to `http://localhost/facebook` to authenticate.
72
2e81654 @uzyn Updated with quick start, support channels, etc
authored
73
6431901 @uzyn Updated links in README
authored
74 Check out [the wiki](https://github.com/uzyn/opauth/wiki) for more in-depth details, especially on how to use Opauth with your own PHP application.
c207b3a @uzyn Opauth readme update
authored
75
f243f83 @uzyn List strategies
authored
76 Available strategies
77 --------------------
1b78167 @uzyn Removed "DO NOT USE" in README
authored
78 A strategy is a set of instructions that interfaces with respective authentication providers and relays it back to Opauth.
b1c0c38 @uzyn formatting
authored
79
80 Provider-specific:
81
57ced94 @uzyn Added muhdazrain's Instagram strategy
authored
82 <table>
83 <tr>
84 <th>Strategy</th>
85 <th>Maintained by</th>
86 </tr>
87 <tr>
8bf6243 @uzyn Updated readme with changelog for 0.4.3, new strategies and new plugins.
authored
88 <td><img src="http://g.etfv.co/http://bitbucket.org" alt="Bitbucket" width="16">&nbsp;&nbsp;
89 <a href="http://github.com/fancyguy/opauth-bitbucket">Bitbucket</a></td>
90 <td>fancyguy</td>
57ced94 @uzyn Added muhdazrain's Instagram strategy
authored
91 </tr>
92 <tr>
8bf6243 @uzyn Updated readme with changelog for 0.4.3, new strategies and new plugins.
authored
93 <td><img src="http://g.etfv.co/http://disqus.com" alt="Disqus" width="16">&nbsp;&nbsp;
94 <a href="https://github.com/rasa/opauth-disqus">Disqus</a></td>
95 <td>rasa</td>
57ced94 @uzyn Added muhdazrain's Instagram strategy
authored
96 </tr>
97 <tr>
8bf6243 @uzyn Updated readme with changelog for 0.4.3, new strategies and new plugins.
authored
98 <td><img src="http://g.etfv.co/http://do.com" alt="Do" width="16">&nbsp;&nbsp;
99 <a href="https://github.com/arbales/opauth-do">Do</a></td>
100 <td>arbales</td>
8ea9e0f @uzyn Added GitHub strategy
authored
101 </tr>
102 <tr>
8bf6243 @uzyn Updated readme with changelog for 0.4.3, new strategies and new plugins.
authored
103 <td><img src="http://g.etfv.co/http://facebook.com" alt="Facebook">&nbsp;&nbsp;
104 <a href="https://github.com/uzyn/opauth-facebook"><strong>Facebook</strong></a></td>
105 <td>uzyn</td>
c7e10af @uzyn Added Silex plugin and Bitbucket strategy.
authored
106 </tr>
107 <tr>
8bf6243 @uzyn Updated readme with changelog for 0.4.3, new strategies and new plugins.
authored
108 <td><img src="http://g.etfv.co/http://www.flickr.com" alt="Flickr">&nbsp;&nbsp;
cb7750f @uzyn Added Flickr and Foursquare
authored
109 <a href="https://github.com/pocket7878/opauth-flickr">Flickr</a></td>
110 <td>pocket7878</td>
111 </tr>
112 <tr>
113 <td><img src="http://g.etfv.co/http://www.foursquare.com" alt="Foursquare" width="16">&nbsp;&nbsp;
114 <a href="https://github.com/pocket7878/opauth-foursquare">Foursquare</a></td>
115 <td>pocket7878</td>
116 </tr>
117 <tr>
8bf6243 @uzyn Updated readme with changelog for 0.4.3, new strategies and new plugins.
authored
118 <td><img src="http://g.etfv.co/http://github.com" alt="GitHub" width="16" height="16">&nbsp;&nbsp;
8ea9e0f @uzyn Added GitHub strategy
authored
119 <a href="https://github.com/uzyn/opauth-github">GitHub</a></td>
120 <td>uzyn</td>
121 </tr>
122 <tr>
8bf6243 @uzyn Updated readme with changelog for 0.4.3, new strategies and new plugins.
authored
123 <td><img src="http://g.etfv.co/http://google.com" alt="Google" width="16">&nbsp;&nbsp;
124 <a href="https://github.com/uzyn/opauth-google"><strong>Google</strong></a></td>
125 <td>uzyn</td>
126 </tr>
127 <tr>
128 <td><img src="http://g.etfv.co/http://instagram.com" alt="Instagram">&nbsp;&nbsp;
57ced94 @uzyn Added muhdazrain's Instagram strategy
authored
129 <a href="https://github.com/muhdazrain/opauth-instagram">Instagram</a></td>
130 <td>muhdazrain</td>
131 </tr>
132 <tr>
8bf6243 @uzyn Updated readme with changelog for 0.4.3, new strategies and new plugins.
authored
133 <td><img src="http://g.etfv.co/http://linkedin.com" alt="LinkedIn">&nbsp;&nbsp;
df3c578 @uzyn Added LinkedIn strategy
authored
134 <a href="https://github.com/uzyn/opauth-linkedin">LinkedIn</a></td>
135 <td>uzyn</td>
136 </tr>
137 <tr>
8bf6243 @uzyn Updated readme with changelog for 0.4.3, new strategies and new plugins.
authored
138 <td><img src="http://g.etfv.co/http://live.com" alt="Live Connect">&nbsp;&nbsp;
110d06e @uzyn Added (Windows) Live Connect strategy
authored
139 <a href="https://github.com/uzyn/opauth-live">(Windows) Live</a></td>
140 <td>uzyn</td>
141 </tr>
142 <tr>
8bf6243 @uzyn Updated readme with changelog for 0.4.3, new strategies and new plugins.
authored
143 <td><img src="http://g.etfv.co/http://mixi.co.jp" alt="mixi">&nbsp;&nbsp;
7f5b63e @uzyn Added mixi strategy
authored
144 <a href="https://github.com/ritou/opauth-mixi">mixi</a></td>
145 <td>ritou</td>
146 </tr>
147 <tr>
8bf6243 @uzyn Updated readme with changelog for 0.4.3, new strategies and new plugins.
authored
148 <td><img src="http://g.etfv.co/http://openid.net" alt="OpenID">&nbsp;&nbsp;
45b7021 @uzyn Added OpenID strategy
authored
149 <a href="https://github.com/uzyn/opauth-openid">OpenID</a></td>
150 <td>uzyn</td>
151 </tr>
8bf6243 @uzyn Updated readme with changelog for 0.4.3, new strategies and new plugins.
authored
152 <tr>
153 <td><img src="http://g.etfv.co/http://paypal.com" alt="PayPal">&nbsp;&nbsp;
154 <a href="https://github.com/24hours/opauth-paypal">PayPal</a></td>
155 <td>24hours</td>
156 </tr>
157 <tr>
158 <td><img src="http://g.etfv.co/http://weibo.com" alt="Sina Weibo" width="16">&nbsp;&nbsp;
159 <a href="https://github.com/dgrabla/opauth-sinaweibo">Sina Weibo (新浪微博)</a></td>
160 <td>dgrabla</td>
161 </tr>
162 <tr>
163 <td><img src="http://g.etfv.co/http://twitter.com" alt="Twitter" width="16">&nbsp;&nbsp;
164 <a href="https://github.com/uzyn/opauth-twitter"><strong>Twitter</strong></a></td>
165 <td>uzyn</td>
166 </tr>
167 <tr>
350414d @LubosRemplik Vimeo opauth strategy added into README file
LubosRemplik authored
168 <td><img src="http://g.etfv.co/http://vimeo.com" alt="Vimeo" width="16">&nbsp;&nbsp;
169 <a href="https://github.com/LubosRemplik/opauth-vimeo">Vimeo</a></td>
170 <td>LubosRemplik</td>
171 </tr>
172 <tr>
8bf6243 @uzyn Updated readme with changelog for 0.4.3, new strategies and new plugins.
authored
173 <td><img src="http://g.etfv.co/http://vk.com" alt="VK" width="16">&nbsp;&nbsp;
174 <a href="https://github.com/dgrabla/opauth-vkontakte">VKontakte</a></td>
175 <td>dgrabla</td>
176 </tr>
177 <tr>
178 <td><img src="http://g.etfv.co/http://developer.yahoo.co.jp" alt="Yahoo! Japan" width="16">&nbsp;&nbsp;
179 <a href="https://github.com/ritou/opauth-yahoojp">Yahoo! Japan (YConnect)</a></td>
180 <td>ritou</td>
181 </tr>
57ced94 @uzyn Added muhdazrain's Instagram strategy
authored
182
183 </table>
b1c0c38 @uzyn formatting
authored
184
1b78167 @uzyn Removed "DO NOT USE" in README
authored
185 Generic strategy: [OAuth](https://github.com/uzyn/opauth-oauth)
186
436fb98 @uzyn 0.4.4 release changelog. #41
authored
187 See [wiki's list of strategies](https://github.com/uzyn/opauth/wiki/List-of-strategies) for an updated list of Opauth strategies or to make requests.
8bf6243 @uzyn Updated readme with changelog for 0.4.3, new strategies and new plugins.
authored
188 Refer also to [strategy contribution guide](https://github.com/uzyn/opauth/wiki/Strategy-contribution-guide) if you would like to contribute a strategy.
b1c0c38 @uzyn formatting
authored
189
0aef28e @uzyn Contribute
authored
190 Requirements
191 -------------
436fb98 @uzyn 0.4.4 release changelog. #41
authored
192 PHP 5 (>= 5.2)
8bf6243 @uzyn Updated readme with changelog for 0.4.3, new strategies and new plugins.
authored
193 with [`allow_url_fopen`](http://php.net/manual/en/filesystem.configuration.php#ini.allow-url-fopen) enabled
f243f83 @uzyn List strategies
authored
194
b10cb12 @uzyn Contribute
authored
195 Contribute
196 ----------
197 Opauth needs your contributions, especially the following:
198
436fb98 @uzyn 0.4.4 release changelog. #41
authored
199 - More strategies
b10cb12 @uzyn Contribute
authored
200 Refer to [wiki](https://github.com/uzyn/opauth/wiki) for contribution guide and inform us when your work is ready.
201
436fb98 @uzyn 0.4.4 release changelog. #41
authored
202 - Plugins for more PHP frameworks and CMSes
3f2e257 @uzyn Added a note on primary support channel
authored
203 eg. Symfony, Laravel, WordPress, Drupal, etc.
b10cb12 @uzyn Contribute
authored
204
436fb98 @uzyn 0.4.4 release changelog. #41
authored
205 - Guides & tutorials
b10cb12 @uzyn Contribute
authored
206 On how to implement Opauth on CakePHP app, etc.
207
208
eae7688 @uzyn *other*
authored
209 Issues & questions
2e81654 @uzyn Updated with quick start, support channels, etc
authored
210 -------------------
436fb98 @uzyn 0.4.4 release changelog. #41
authored
211 - Discussion group: [Google Groups](https://groups.google.com/group/opauth)
7344f9a @uzyn v0.4.1 release
authored
212 _Primary channel for support, especially usage questions._
b0e6ddf @huglester Fixed invalid github link
huglester authored
213 - Issues: [Github Issues](https://github.com/opauth/opauth/issues)
436fb98 @uzyn 0.4.4 release changelog. #41
authored
214 - Twitter: [@uzyn](http://twitter.com/uzyn)
215 - Email me: chua@uzyn.com
2e81654 @uzyn Updated with quick start, support channels, etc
authored
216 - IRC: **#opauth** on [Freenode](http://webchat.freenode.net/?channels=opauth&uio=d4)
217
1b78167 @uzyn Removed "DO NOT USE" in README
authored
218 <p>Used Opauth in your project? Let us know!</p>
ef207b9 @uzyn Markdowned README
authored
219
52c3bb4 @uzyn Changelog for 0.2.0
authored
220 Changelog
221 ---------
7344f9a @uzyn v0.4.1 release
authored
222
436fb98 @uzyn 0.4.4 release changelog. #41
authored
223 ####v0.4.4 _(10 May 2013)_
224 - Added HTTP User-Agent header. _(thanks @rkaldung #41)_
225
8bf6243 @uzyn Updated readme with changelog for 0.4.3, new strategies and new plugins.
authored
226 ####v0.4.3 _(10 January 2013)_
227 - Fixed a `serverPost()` bug where user-supplied options were not applied correctly. _(thanks @ritou #26)_
228
4971b37 @uzyn Bump to v0.4.2
authored
229 ####v0.4.2 _(28 August 2012)_
cf449f9 @uzyn Formatting fix
authored
230 - Fix session to check for `session_id()` instead of `$_SESSION` _(thanks @sirikkoster #20)_
4971b37 @uzyn Bump to v0.4.2
authored
231
7344f9a @uzyn v0.4.1 release
authored
232 ####v0.4.1 _(22 July 2012)_
233 - Not starting session if session is already started. _(thanks @Claymm)_
234 - Fixed incorrect error message. _(thanks @Claymm)_
235 - Removed `@` for `file_get_contents`. _(thanks @Takehiro-Adachi)_
236
237 ####v0.4.0 _(10 June 2012)_
a442493 @uzyn v0.4.0 changelog
authored
238 - `mapProfile()` and `clientGet()` for OpauthStrategy class.
239
7344f9a @uzyn v0.4.1 release
authored
240 ####v0.3.0 _(30 May 2012)_
a2dd742 @uzyn v0.3.0 changelog
authored
241 - Some unit testing
242 - More consistent naming of Strategy's internal properties
243 - Smarter loading of strategy, able to make a few guesses on where the class file might be at.
244
7344f9a @uzyn v0.4.1 release
authored
245 ####v0.2.0 _(23 May 2012)_
52c3bb4 @uzyn Changelog for 0.2.0
authored
246 - Opauth is now Composer compatible and listed on [Packagist](http://packagist.org/packages/opauth/opauth)
247 - Opauth now supports autoloaders
8537e2d @uzyn changelog updates
authored
248 - If a strategy is not autoloaded, Opauth falls back and searches for it at `strategy_dir` defined in config.
249 - Class name for strategy Foo should now be FooStrategy instead of Foo.
250 - This is to reduce the likelihood of class name collision due to Opauth not requiring the use of namespace.
251 - v0.1.0-type class name, ie. Foo, still works, but is now deprecated.
52c3bb4 @uzyn Changelog for 0.2.0
authored
252
7344f9a @uzyn v0.4.1 release
authored
253 ####v0.1.0 _(22 May 2012)_
a2dd742 @uzyn v0.3.0 changelog
authored
254 - Initial release
52c3bb4 @uzyn Changelog for 0.2.0
authored
255
ef207b9 @uzyn Markdowned README
authored
256 License
257 ---------
436fb98 @uzyn 0.4.4 release changelog. #41
authored
258 The MIT License
8bf6243 @uzyn Updated readme with changelog for 0.4.3, new strategies and new plugins.
authored
259 Copyright © 2012-2013 U-Zyn Chua (http://uzyn.com)
2e81654 @uzyn Updated with quick start, support channels, etc
authored
260
7344f9a @uzyn v0.4.1 release
authored
261 Consultation
2e81654 @uzyn Updated with quick start, support channels, etc
authored
262 ---------
436fb98 @uzyn 0.4.4 release changelog. #41
authored
263 U-Zyn Chua is a Principal Consultant at [Zynesis Consulting](http://zynesis.com).
350414d @LubosRemplik Vimeo opauth strategy added into README file
LubosRemplik authored
264 Looking for PHP web development solutions or consultation? [Drop me a mail](mailto:chua@uzyn.com).
Something went wrong with that request. Please try again.