fix: add and document recovery to quickstart

ory · Jul 3, 2020 · c229c54 · c229c54
1 parent 81903a5
commit c229c54
Show file tree

Hide file tree

Showing 7 changed files with 51 additions and 2 deletions.
diff --git a/contrib/quickstart/kratos/email-password/.kratos.yml b/contrib/quickstart/kratos/email-password/.kratos.yml
@@ -19,7 +19,7 @@ selfservice:
 
     settings:
       ui_url: http://127.0.0.1:4455/settings
-      privileged_session_max_age: 1m
+      privileged_session_max_age: 15m
 
     recovery:
       enabled: true

diff --git a/contrib/quickstart/kratos/email-password/identity.traits.schema.json b/contrib/quickstart/kratos/email-password/identity.traits.schema.json
@@ -17,6 +17,9 @@
         },
         "verification": {
           "via": "email"
+        },
+        "recovery": {
+          "via": "email"
         }
       }
     }

diff --git a/docs/docs/quickstart.mdx b/docs/docs/quickstart.mdx
@@ -20,7 +20,7 @@ merely a guide to get you set up with some examples.
   src="https://www.youtube.com/embed/5t1Zr_zJc7E"
   frameborder="0"
   allowfullscreen
-></iframe>
+/>
 
 ## Use Case: Application Login and Registration
 
@@ -530,6 +530,52 @@ response):
 To re-request the verification email, fill out the form at
 [127.0.0.1:4455/verify](http://127.0.0.1:4455/verify).
 
+To learn more about verification recovery, head over to the
+[Email and Phone Verification and Account Activation Documentation](self-service/flows/verify-email-account-activation.mdx).
+
+### Account Recovery
+
+The quickstart has account recovery enabled. To recover an account, log out and
+click on "Recover account":
+
+<p>
+  <img
+    alt="Click on 'recover account'"
+    src={useBaseUrl('img/docs/quickstart-recover-i.png')}
+  />
+</p>
+
+The next screen shows a HTML form where you enter your email address:
+
+<p>
+  <img
+    alt="Enter your email address"
+    src={useBaseUrl('img/docs/quickstart-recover-ii.png')}
+  />
+</p>
+
+Hit "submit" and check the emails for the account recovery message:
+
+<p>
+  <img
+    alt="Check your email for the password reset email"
+    src={useBaseUrl('img/docs/quickstart-recover-iii.png')}
+  />
+</p>
+
+Click the link, and change your password:
+
+<p>
+  <img
+    alt="Change your password"
+    src={useBaseUrl('img/docs/quickstart-recover-iv.png')}
+  />
+</p>
+
+You are now able to sign in with the new password. To learn more about account
+recovery, head over to the
+[Account Recovery Documentation](self-service/flows/account-recovery.mdx).
+
 #### Configuration
 
 You can find all configuration files used for this quickstart guide in

diff --git a/docs/static/img/docs/quickstart-recover-i.png b/docs/static/img/docs/quickstart-recover-i.png
diff --git a/docs/static/img/docs/quickstart-recover-ii.png b/docs/static/img/docs/quickstart-recover-ii.png
diff --git a/docs/static/img/docs/quickstart-recover-iii.png b/docs/static/img/docs/quickstart-recover-iii.png
diff --git a/docs/static/img/docs/quickstart-recover-iv.png b/docs/static/img/docs/quickstart-recover-iv.png