Basic Auth
Nuxt 3 Module for Basic Authentication.
Features
- ✅ Simple to use
- ✅ Supports multiple users
- ✅ Whitelist routes
Quick Setup
- Add
@kgierke/nuxt-basic-auth
dependency to your project
# Using pnpm
pnpm add -D @kgierke/nuxt-basic-auth
# Using yarn
yarn add --dev @kgierke/nuxt-basic-auth
# Using npm
npm install --save-dev @kgierke/nuxt-basic-auth
- Add
@kgierke/nuxt-basic-auth
to themodules
section ofnuxt.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: 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 <username>:<password>,<username2>:<password2> |
usersDelimiter | string | , | Delimiter for users string. |
allowedRoutes | string[] | [] | Array of routes that are not protected by Basic Auth. Supports regex patterns. |
Development
# 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