Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spatie/laravel-littlegatekeeper
Protect pages from access with a universal username/password
https://github.com/spatie/laravel-littlegatekeeper
laravel php security
Last synced: 4 days ago
JSON representation
Protect pages from access with a universal username/password
- Host: GitHub
- URL: https://github.com/spatie/laravel-littlegatekeeper
- Owner: spatie
- License: mit
- Created: 2015-06-11T10:24:21.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2024-05-23T10:08:19.000Z (6 months ago)
- Last Synced: 2024-06-18T21:49:48.782Z (5 months ago)
- Topics: laravel, php, security
- Language: PHP
- Homepage: https://spatie.be/opensource/laravel
- Size: 77.1 KB
- Stars: 180
- Watchers: 5
- Forks: 21
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# laravel-littlegatekeeper
[](https://packagist.org/packages/spatie/laravel-littlegatekeeper)
[](LICENSE.md)
[](https://github.com/spatie/laravel-littlegatekeeper/actions/workflows/run-tests.yml)
[](https://packagist.org/packages/spatie/laravel-littlegatekeeper)
Protect pages from access with a universal username/password combination (set by configuration).
Spatie is a webdesign agency in Antwerp, Belgium. You'll find an overview of all our open source projects [on our website](https://spatie.be/opensource).
## Support us
[
](https://spatie.be/github-ad-click/laravel-littlegatekeeper)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Postcardware
You're free to use this package (it's [MIT-licensed](LICENSE.md)), but if it makes it to your production environment you are required to send us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.
The best postcards will get published on the open source page on our website.
## Install
You can install the package via Composer:
```bash
$ composer require spatie/laravel-littlegatekeeper
```
Start by registering the package's the service provider:
```php
// config/app.php (L5)
'providers' => [
// ...
'Spatie\LittleGateKeeper\LittleGateKeeperServiceProvider',
],
```
Next, publish the config files:
```bash
$ php artisan vendor:publish --provider="Spatie\LittleGateKeeper\LittleGateKeeperServiceProvider" --tag="config"
```
Finally, register the middleware:
```php
// app/Http/Kernel.php
protected $routeMiddleware = [
// ...
'littlegatekeeper' => \Spatie\LittleGateKeeper\AuthMiddleware::class,
];
```
## Usage
First set up the username and password in your configuration file or .env file
In your .env file add:
```php
// ...
GATEKEEPER_USERNAME=Choose_your_username
GATEKEEPER_PASSWORD=Choose_your_secret_password
```
You can protect your routes by applying the middleware:
```php
Route::get('/', ['middleware' => 'littlegatekeeper', function () {
return view('protectedpage');
}]);
```
If a user isn't logged in, he will be redirected to the url set in the config file (`littlegatekeeper.authRoute`).
### Authenticator methods
```php
/**
* @param array $credentials Format: ['username' => '...', 'password' => '...']
* @return bool
*/
public function attempt($credentials)
```
```php
/**
* @return bool
*/
public function isAuthenticated()
```
```php
protected function logout()
```
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
## Security
If you've found a bug regarding security please mail [[email protected]](mailto:[email protected]) instead of using the issue tracker.
## Credits
- [Sebastian De Deyne](https://github.com/sebastiandedeyne)
- [All Contributors](../../contributors)
## About Spatie
Spatie is a webdesign agency in Antwerp, Belgium. You'll find an overview of all our open source projects [on our website](https://spatie.be/opensource).
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.