@ackplus/nest-auth 1.1.63 → 1.1.65

package/README.md

@@ -113,6 +113,54 @@ NestAuthModule.forRoot({
 })
 ```
 
+## Session Storage Options
+
+By default, sessions are stored in the database via TypeORM. You can switch to Redis for
+multi-instance performance without changing your login/signup flows.
+
+### Redis Setup
+
+1) Install the optional Redis dependency:
+
+```bash
+npm install ioredis
+```
+
+2) Enable Redis sessions:
+
+```typescript
+import { SessionStorageType } from '@ackplus/nest-auth';
+
+NestAuthModule.forRoot({
+  session: {
+    storageType: SessionStorageType.REDIS, // or 'redis'
+    redis: {
+      url: process.env.REDIS_URL, // preferred when available
+      host: '127.0.0.1',
+      port: 6379,
+      password: process.env.REDIS_PASSWORD,
+      db: 0,
+      tls: undefined,
+      keyPrefix: 'nest-auth:sess:',
+      ttlSeconds: 60 * 60 * 24 * 7,
+      enableOfflineQueue: true,
+    },
+  },
+});
+```
+
+Notes:
+- If `session.storageType` is omitted, the database store is used (no breaking changes).
+- Legacy config is still supported: `session.redisUrl`.
+- Redis keys are JSON-serialized and use TTL; `ttlSeconds` defaults to the session expiry when possible.
+
+### Production Notes
+
+- Enable Redis persistence (AOF/RDB) for durability.
+- Use Redis clustering/sentinel for high availability.
+- Choose a consistent `keyPrefix` to isolate environments.
+- Monitor TTL/evictions and memory usage.
+
 ## Documentation
 
 For full documentation covering RBAC, Tenants, and advanced configuration, please refer to the official docs (link to be added).