PHPackages                             oralunal/scribe-auth - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. oralunal/scribe-auth

ActiveLibrary[API Development](/categories/api)

oralunal/scribe-auth
====================

A Laravel middleware package that adds authentication protection to your Scribe API documentation.

v1.1.0(1mo ago)22.0k↓41.1%[1 issues](https://github.com/oralunal/scribe-auth/issues)MITPHPPHP ^8.2

Since Apr 28Pushed 1mo ago1 watchersCompare

[ Source](https://github.com/oralunal/scribe-auth)[ Packagist](https://packagist.org/packages/oralunal/scribe-auth)[ Docs](http://github.com/oralunal/scribe-auth)[ RSS](/packages/oralunal-scribe-auth/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (5)Dependencies (4)Versions (6)Used By (0)

Scribe Auth Middleware
======================

[](#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
------------

[](#requirements)

1. Scribe's `type` config should be set to `laravel` in your `config/scribe.php` file.
2. Scribe's `laravel->add_routes` config should be set to `true` in your `config/scribe.php` file.

Installation
------------

[](#installation)

1. Install the package via Composer:

```
composer require oralunal/scribe-auth
```

2. Add the `web` and `scribe.auth` middleware to your `config/scribe.php` file:

```
'middleware' => [
    // ...
    'web',
    'scribe.auth',
],
```

3. Publish the configuration file:

```
php artisan vendor:publish --tag=scribe-auth-config
```

Configuration
-------------

[](#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:

```
SCRIBE_AUTH_ENABLED=true
SCRIBE_AUTH_PASSWORD=your_fantastic_password
```

Security
--------

[](#security)

- Use different credentials in production
- Choose a strong password
- Keep your credentials secure

License
-------

[](#license)

This package is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).

###  Health Score

44

—

FairBetter than 92% of packages

Maintenance79

Regular maintenance activity

Popularity24

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~82 days

Total

5

Last Release

56d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/4e5f91240abd67ed47abf703e5069261011ff82f47f864ba68a5511bbddeea62?d=identicon)[oralunal](/maintainers/oralunal)

---

Top Contributors

[![oralunal](https://avatars.githubusercontent.com/u/1948737?v=4)](https://github.com/oralunal "oralunal (6 commits)")

---

Tags

laravelscribe-api-documentationmiddlewareapilaraveldocumentation

### Embed Badge

![Health badge](/badges/oralunal-scribe-auth/health.svg)

```
[![Health](https://phpackages.com/badges/oralunal-scribe-auth/health.svg)](https://phpackages.com/packages/oralunal-scribe-auth)
```

###  Alternatives

[darkaonline/l5-swagger

OpenApi or Swagger integration to Laravel

2.9k34.0M112](/packages/darkaonline-l5-swagger)[knuckleswtf/scribe

Generate API documentation for humans from your Laravel codebase.✍

2.3k12.2M45](/packages/knuckleswtf-scribe)[despark/apidoc

Generate api documentation and use swagger to consume it

132.3k](/packages/despark-apidoc)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)