Nuxt 2 is reaching End-of-Life on June 30th, 2024.


Nuxt Module for Basic Authentication

Basic Auth

npm versionnpm downloadsLicenseNuxt

Nuxt 3 Module for Basic Authentication.


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

Quick Setup

  1. 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
  1. Add @kgierke/nuxt-basic-auth to the modules section of nuxt.config.ts
export default defineNuxtConfig({
  modules: ["@kgierke/nuxt-basic-auth"],
  1. 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 ✨


enabledbooleantrueEnables or disables Basic Auth.
usersarray[]Array of users. Each user must have a username and password property. Can also be formatted as string <username>:<password>,<username2>:<password2>
usersDelimiterstring,Delimiter for users string.
allowedRoutesstring[][]Array of routes that are not protected by Basic Auth. Supports regex patterns.


# 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