基本身份验证

用于基本身份验证的 Nuxt 3 模块。

✨ 发布说明

功能

✅ 使用简单
✅ 支持多个用户
✅ 白名单路由

快速设置

使用一条命令将模块安装到您的 Nuxt 应用程序中

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

在 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/.*"],
  },
});

就是这样！您现在可以在您的 Nuxt 应用程序中使用基本身份验证 ✨

选项

选项	类型	默认值	描述
`enabled`	`布尔值`	`true`	启用或禁用基本身份验证。
`users`	`数组`	`[]`	用户数组。每个用户必须具有 `username` 和 `password` 属性。也可以格式化为字符串 `<username>:<password>,<username2>:<password2>`
`usersDelimiter`	`字符串`	`,`	用户字符串的分隔符。
`allowedRoutes`	`字符串数组`	`[]`	不受基本身份验证保护的路由数组。支持正则表达式模式。

所有选项也可以通过环境变量设置，使用 NUXT_BASIC_AUTH_ 前缀。例如，NUXT_BASIC_AUTH_ENABLED=true。

开发

# 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