code16/privat

Simple private access package for Laravel.

Privat

, _(*1)

Privat is a very simple password protection for Laravel projects. It's useful for websites in a staging state., _(*2)

, _(*3)

Usage

Install with composer

composer require code16/privat

Configure Privat via .env keys

PRIVAT_ENABLED=true
PRIVAT_PASSWORD=mypassword

Advanced usage

Choose impacted middleware groups

By default, Privat will protect the web middleware group. If you want to impact other groups, you can tweak the corresponding .env key:, _(*4)

PRIVAT_MIDDLEWARE_GROUP=web,admin

Handle exceptions

You can exclude some hosts or URLs from Privat:, _(*5)

PRIVAT_EXCEPTED_URLS="/login,/admin"
PRIVAT_EXCEPTED_HOSTS="admin.mywebsite.com"

Waiting page

If you need to present a public waiting page, set the waiting page view name in the PRIVAT_WAITING_VIEW env key:, _(*6)

PRIVAT_WAITING_VIEW="demo.waiting"

From then, all requests without the Privat registration will be redirected to /privat_waiting which will render the configured view, except /privat, which will still present the Privat form., _(*7)

Publish the config file

Of course, you can publish the config file instead of using env variables (even if we think it’s more convenient for such a tool):, _(*8)

php artisan vendor:publish --provider="Code16\Privat\PrivatServiceProvider"

How does it work

Quite simple: if the given password is correct, Privat sets a session property, and look for it on each request. So, obviously, Privat won't work on non session based systems (an API for instance)., _(*9)

License

MIT, _(*10)