Download the PHP package oralunal/scribe-auth without Composer
On this page you can find all versions of the php package oralunal/scribe-auth. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download oralunal/scribe-auth
More information about oralunal/scribe-auth
Files in oralunal/scribe-auth
Package scribe-auth
Short Description A Laravel middleware package that adds authentication protection to your Scribe API documentation.
License MIT
Homepage http://github.com/oralunal/scribe-auth
Informations about the package scribe-auth
Scribe Auth Middleware
A Laravel middleware package that adds authentication protection to your Scribe API documentation. This package provides a simple way to secure your API documentation with basic authentication, ensuring that only authorized users can access your API documentation pages.
Requirements
- Scribe's
typeconfig should be set tolaravelin yourconfig/scribe.phpfile. - Scribe's
laravel->add_routesconfig should be set totruein yourconfig/scribe.phpfile.
Installation
-
Install the package via Composer:
-
Add the
webandscribe.authmiddleware to yourconfig/scribe.phpfile: - Publish the configuration file:
Configuration
The package comes with a config file (config/scribe-auth.php) where you can customize the following settings:
SCRIBE_AUTH_ENABLED: Enable/disable the middleware (Default:false)SCRIBE_AUTH_PASSWORD: Authentication password (Default:1234567890)
Add the following environment variable to your .env file:
Security
- Use different credentials in production
- Choose a strong password
- Keep your credentials secure
License
This package is open-sourced software licensed under the MIT license.