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
type
config should be set tolaravel
in yourconfig/scribe.php
file. - Scribe's
laravel->add_routes
config should be set totrue
in yourconfig/scribe.php
file.
Installation
-
Install the package via Composer:
-
Add the
web
andscribe.auth
middleware to yourconfig/scribe.php
file: - 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.