Home

Opauth is a multi-provider authentication framework for PHP, inspired by OmniAuth for Ruby.

Current version: 0.2.0

Installation

Pick and choose your favorite installation method:

###i. Via Composer

Composer is a dependency manager for PHP.

To install Opauth core only, include opauth/opauth to your composer.json:

{
    "require":{
        "opauth/opauth": "*"
    }
}

Opauth requires strategies to work. We suggest that you add these packages as well for Facebook, Google and/or Twitter authentication support.

{
    "require":{
        "opauth/opauth": "*",
        "opauth/facebook": "*",
        "opauth/google": "*",
        "opauth/twitter": "*"
    }
}

Run php composer.phar install

###ii. Manual download

Download Opauth (ZIP) and unzip it.

Download additional strategies and place them in directories at path_to_opauth/Strategy.
Remember to name the directory name as Strategy. For example, place Facebook strategy files in path_to_opauth/Strategy/Facebook so that FacebookStrategy.php can be found at path_to_opauth/Strategy/Facebook/FacebookStrategy.php.

If you prefer git clone, you can simply run the following without worrying about renaming:

cd path_to_opauth/Strategy
git clone git://github.com/uzyn/opauth-facebook.git Facebook

Note: You can have Strategy/ directory anywhere in your system. All you have to do is explicitly define strategy_dir in your Opauth configuration.

###iii. As plugin on other PHP frameworks If you are using any of the following PHP frameworks, you can install Opauth as a plugin or extension. Follow the instructions at the respective packages:

• CakePHP (maintained by uzyn)
• Yii Framework (maintained by kahwee)

Made a plugin? Edit this wiki and add yours!