Basic Auth

Basic認証用の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アプリでBasic認証を使用できるようになりました✨

オプション

オプション	タイプ	デフォルト	説明
`enabled`	`boolean`	`true`	Basic認証を有効または無効にします。
`users`	`array`	`[]`	ユーザーの配列。各ユーザーは`username`プロパティと`password`プロパティを持っている必要があります。文字列`<username>:<password>,<username2>:<password2>`としてフォーマットすることもできます。
`usersDelimiter`	`string`	`,`	ユーザー文字列の区切り文字。
`allowedRoutes`	`string[]`	`[]`	Basic認証で保護されないルートの配列。正規表現パターンをサポートします。

すべてのオプションは、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