Merge branch 'main' of github.com:devforth/adminforth

Author: ivictbor

adminforth/documentation/docs/tutorial/09-Plugins/07-email-password-reset.md

@@ -16,10 +16,13 @@ Plugin allows to reset password for admin users who forgot their password by sen
 Installation:
 
 ```bash
-pnpm install @adminforth/email-password-reset --save
-pnpm install @adminforth/email-adapter-aws-ses --save
+pnpm add @adminforth/email-password-reset
+pnpm add @adminforth/email-adapter-aws-ses
+pnpm add @adminforth/key-value-adapter-ram
 ```
 
+>⚠️Note: we use key/value adapter to store used password reset token for validity period and we recomend to use stateful adapter like Redis in production, because stateless adapter (like key/value RAM) is cleared after server restart and password reset token could be re-used for the second time 
+
 Import plugin:
 
 ```typescript
@@ -42,6 +45,8 @@ Add plugin to user resource:
 ```typescript ./resources/adminuser.ts
 import EmailResetPasswordPlugin from '@adminforth/email-password-reset';
 import EmailAdapterAwsSes from '@adminforth/email-adapter-aws-ses';
+import KeyValueAdapterRam from '@adminforth/key-value-adapter-ram';
+
 ...
 plugins: [
   ...
@@ -56,12 +61,12 @@ plugins: [
     sendFrom: 'no-reply@devforth.io',
 
     adapter: new EmailAdapterAwsSes({
-        // region where SES is setup
-        region: "eu-central-1",
-        accessKeyId: process.env.AWS_ACCESS_KEY_ID as string,
-        secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY as string,
-      }),
-
+      // region where SES is setup
+      region: "eu-central-1",
+      accessKeyId: process.env.AWS_ACCESS_KEY_ID as string,
+      secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY as string,
+    }),
+    userResetTokensKeyValueAdapter: new KeyValueAdapterRam(),
   }),
 ]
 ```
@@ -102,12 +107,12 @@ plugins: [
     sendFrom: 'no-reply@devforth.io',
 
     adapter: new EmailAdapterMailgun({
-        apiKey: process.env.MAILGUN_API_KEY as string,
-        domain: process.env.MAILGUN_DOMAIN as string,
-        //baseUrl is optional, if not provided, will default to "https://api.mailgun.net" but if you are using Mailgun EU, you should use "https://api.eu.mailgun.net" instead
-        baseUrl: process.env.MAILGUN_REGION_URL as string,
-      }),
-
+      apiKey: process.env.MAILGUN_API_KEY as string,
+      domain: process.env.MAILGUN_DOMAIN as string,
+      //baseUrl is optional, if not provided, will default to "https://api.mailgun.net" but if you are using Mailgun EU, you should use "https://api.eu.mailgun.net" instead
+      baseUrl: process.env.MAILGUN_REGION_URL as string,
+    }),
+    userResetTokensKeyValueAdapter: new KeyValueAdapterRam(),
   }),
 ]
 ```