Basic Auth

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]

Nuxt 3 Module for Basic Authentication.

- ✨  Release Notes

Features

- ✅ Simple to use
- ✅ Supports multiple users
- ✅ Whitelist routes

Quick Setup

Install the module to your Nuxt application with one command:

``bash
npx nuxi module add @kgierke/nuxt-basic-auth
`

Configure the module in nuxt.config.ts

`js
export default defineNuxtConfig({
modules: ["@kgierke/nuxt-basic-auth"],

basicAuth: {
enabled: true,
users: [
{
username: "admin",
password: "admin",
},
],
// Optional: Delimiter for users string
// usersDelimiter: ",",
// Optional: Whitelist routes
// allowedRoutes: ["/api/.*"],
},
});
`

That's it! You can now use Basic Auth in your Nuxt app ✨

Options

| Option | Type | Default | Description |
| ---------------- | ---------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| enabled | boolean | true | Enables or disables Basic Auth. |
| users | array | [] | Array of users. Each user must have a username and password property. Can also be formatted as string :,: |
| usersDelimiter | string | , | Delimiter for users string. |
| allowedRoutes | string[] | [] | Array of routes that are not protected by Basic Auth. Supports regex patterns. |

All options can also be set through environment variables, using the NUXT_BASIC_AUTH_ prefix. For example, NUXT_BASIC_AUTH_ENABLED=true.

Development

`bash


Install dependencies

npm install

Generate type stubs

npm run dev:prepare

Develop with the playground

npm run dev

Build the playground

npm run dev:build

Run ESLint

npm run lint

Run Vitest

npm run test
npm run test:watch

Release new version

npm run release
``

[npm-version-src]: https://img.shields.io/npm/v/@kgierke/nuxt-basic-auth/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/@kgierke/nuxt-basic-auth
[npm-downloads-src]: https://img.shields.io/npm/dm/@kgierke/nuxt-basic-auth.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/@kgierke/nuxt-basic-auth
[license-src]: https://img.shields.io/npm/l/@kgierke/nuxt-basic-auth.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/@kgierke/nuxt-basic-auth
[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
[nuxt-href]: https://nuxt.com