laravel-package laravel

stormpath/laravel

Build simple, secure web applications with Stormpath and Laravel!

, _(*1)

Getting Started

Follow these steps to add Stormpath user authentication to your Laravel app., _(*2)

1. Download Your Key File, _(*3)

   Download your key file from the Stormpath Console., _(*4)

2. Store Your Key As Environment Variables, _(*5)

   Open your key file and grab the API Key ID and API Key Secret, then add this to your .env file in the root of your project:, _(*6)

   STORMPATH_CLIENT_APIKEY_ID=<YOUR-ID-HERE>
   STORMPATH_CLIENT_APIKEY_SECRET=<YOUR-SECRET-HERE>
   

3. Get Your Stormpath App HREF, _(*7)

   Login to the Stormpath Console and grab the HREF (called REST URL in the UI) of your Application. It should look something like this:, _(*8)

   https://api.stormpath.com/v1/applications/q42unYAj6PDLxth9xKXdL, _(*9)

4. Store Your Stormpath App HREF In the .env file, _(*10)

   STORMPATH_APPLICATION_HREF=<YOUR-STORMPATH-APP-HREF>
   

5. Install The Package, _(*11)

   Open your composer.json file and add the following to your require block:, _(*12)

   "stormpath/laravel": "^0.4"
   

6. Include It In Your App, _(*13)

   Open you config/app.php file and add the following to your providers section, _(*14)

   Stormpath\Laravel\Support\StormpathLaravelServiceProvider::class
   

7. Configure It, _(*15)

   To modify the configuration of the package, you will need to publish the config file. Run the following in your terminal:, _(*16)

   $ php artisan vendor:publish
   

8. Protect Your Routes, _(*17)

   You can use stormpath.auth as a middleware to protect your routes:, _(*18)

   Route::get('/page', ['middleware'=>'stormpath.auth']);
   

   If the user tries to access this route without being logged in, they will be redirected to the login page., _(*19)

   If you want to make sure ONLY guests can use the route, You can use stormpath.guest as a middleware:, _(*20)

   Route::get('/page', ['middleware'=>'stormpath.guest']);
   

   If the user tries to access this route while logged in, they will be redirected to the home page., _(*21)

9. Login, _(*22)

   To access a protected route, the user must first login., _(*23)

   You can login by visiting the /login URL and submitting the login form., _(*24)

10. Register, _(*25)

    To be able to login, your users first need an account., _(*26)

    Users can register by visiting the /register URL and submitting the registration form., _(*27)

11. That's It!, _(*28)

    You just added user authentication to your app with Stormpath. See the documentation for further information on how Stormpath can be used with your Laravel app., _(*29)

Documentation

For basic documentation of this library, see the documentation., _(*30)

Support

If you are having issues with this package, please feel free to submit an issue on this github repository. If it is an issue you are having that needs a little more private attention, please feel free to contact us at support@stormpath.com or visit our support center., _(*31)

Contributing

We welcome anyone to make contributions to this project. Just fork the develop branch of this repository, make your changes, then issue a pull request on the develop branch., _(*32)

Any pull request you make will need to have associated tests with them. If a test is not provided, the pull request will be closed automatically. Also, any pull requests made to a branch other than develop will be closed and a new submission will need to be made to the develop branch., _(*33)

We regularly maintain this repository, and are quick to review pull requests and accept changes!, _(*34)

Copyright

Copyright © 2013-2015 Stormpath, Inc. and contributors., _(*35)

This project is open-source via the Apache 2.0 License., _(*36)