Basic Auth

Nuxt 3 Module for Basic Authentication.

✨ Release Notes

Features

✅ Simple to use
✅ Supports multiple users
✅ Whitelist routes

Quick Setup

Add @kgierke/nuxt-basic-auth dependency to your project

# Using pnpmpnpm add -D @kgierke/nuxt-basic-auth# Using yarnyarn add --dev @kgierke/nuxt-basic-auth# Using npmnpm install --save-dev @kgierke/nuxt-basic-auth

Add @kgierke/nuxt-basic-auth to the modules section of nuxt.config.ts

export default defineNuxtConfig({  modules: ["@kgierke/nuxt-basic-auth"],});

Configure the module in nuxt.config.ts

export default defineNuxtConfig({  modules: ["@kgierke/nuxt-basic-auth"],  basicAuth: {    enabled: true,    users: [      {        username: "admin",        password: "admin",      },    ],    // 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 `<username>:<password>,<username2>:<password2>`
`allowedRoutes`	`string[]`	`[]`	Array of routes that are not protected by Basic Auth. Supports regex patterns.

Development

# Install dependenciesnpm install# Generate type stubsnpm run dev:prepare# Develop with the playgroundnpm run dev# Build the playgroundnpm run dev:build# Run ESLintnpm run lint# Run Vitestnpm run testnpm run test:watch# Release new versionnpm run release