@strapi-community/plugin-better-auth-dashboard 1.0.0-alpha.1 → 1.0.0-alpha.10

package/README.md

@@ -0,0 +1,101 @@
+# Strapi + Better Auth Dashboard
+
+An admin panel dashboard plugin for [Strapi](https://strapi.io) that provides user management, session monitoring, and analytics for [Better Auth](https://better-auth.com) authentication.
+
+> [!CAUTION]
+> This plugin is in BETA state. It is by no means considered stable and should not be used in production. If you want to contribute to its development, please contact any of the maintainers.
+
+## Features
+
+- Overview page with user metrics, growth charts, and cohort retention analysis
+- User management: search, create, edit, delete, and ban users
+- Session management: view and revoke active sessions per user from the user detail drawer
+- Organization management (when the Better Auth organization plugin is enabled)
+- Real-time active user tracking (DAU / WAU / MAU)
+- Automatic feature detection — ban, 2FA, email verification, and organization UI adapts to your Better Auth config
+
+## Installation
+
+The additional dashboard plugin requires you to have the Better Auth plugin already installed and configured.
+
+### Packages
+
+```bash
+npm install @better-auth/infra @strapi-community/plugin-better-auth-dashboard
+# or
+yarn add @better-auth/infra @strapi-community/plugin-better-auth-dashboard
+# or
+pnpm add @better-auth/infra @strapi-community/plugin-better-auth-dashboard
+```
+
+### Configuration
+
+> [!CAUTION]
+> This plugin only works if you have not changed the `basePath` of Better Auth. It needs to be the default `/api/auth` path.
+
+In order to run this plugin you need to configure the `dash()` and `jwt()` plugins from Better Auth.
+
+```typescript title="src/lib/auth.ts"
+import { dash } from "@better-auth/infra";
+import { betterAuth } from 'better-auth';
+import { jwt } from 'better-auth/plugins';
+import { strapiAdapter } from '@strapi-community/plugin-better-auth';
+
+export const auth = betterAuth({
+  database: strapiAdapter(),
+  trustedOrigins: ['http://localhost:3000'],
+  plugins: [
+    jwt(),
+    dash({
+      apiUrl: process.env.STRAPI_URL || "http://localhost:1337",
+      apiKey:
+        process.env.BETTER_AUTH_DASHBOARD_SECRET ||
+        "strapi-internal-dashboard-key",
+    }),
+  ],
+  advanced: {
+    database: {
+      generateId: 'serial',
+    },
+  },
+  emailAndPassword: {
+    enabled: true,
+  },
+});
+```
+
+### Start Strapi
+
+```bash
+pnpm develop
+```
+
+The dashboard is now available in the Strapi admin panel.
+
+## Pages
+
+| Tab | Description |
+| --- | ----------- |
+| **Overview** | User metrics, growth charts, cohort retention, active user rings |
+| **Users** | Searchable user table with create, edit, delete, ban, and session revoke per user |
+| **Organizations** | Organization list with member management (requires Better Auth `organization` plugin) |
+
+## Requirements
+
+- `@strapi-community/plugin-better-auth` installed and configured
+- Strapi v5.45.0+
+- Better Auth >= 1.4.0
+
+## Resources
+
+- [Documentation](https://strapi-community.github.io/plugin-better-auth/docs/better-auth/dashboard)
+- [Better Auth Documentation](https://better-auth.com)
+- [Strapi Documentation](https://docs.strapi.io)
+
+## Authors
+
+- [Boaz Poolman](https://github.com/boazpoolman)
+
+## License
+
+See the [LICENSE](./LICENSE.md) file for licensing information.