From c06aa366474b4f56d67b1971d8feb5472e015278 Mon Sep 17 00:00:00 2001 From: Michael Quigley Date: Fri, 9 Sep 2022 14:13:33 -0400 Subject: [PATCH] docs --- docs/account-requests.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 docs/account-requests.md diff --git a/docs/account-requests.md b/docs/account-requests.md new file mode 100644 index 00000000..cacda1fb --- /dev/null +++ b/docs/account-requests.md @@ -0,0 +1,16 @@ +# Account Request Process + +## In v0.1 + +The `v0.1` versions of `zrok` had an open-access `zrok create account` that allows any user to create an account. Useful for closed development environments only. + +## In v0.2 + +* The `zrok create account` command now only takes an email address. +* The email address is submitted to an open-ended API endpoint, which then records an "account request", allocating a request token. +* An email is sent to the address offering a link with the request token, allowing the user to create the account. +* The account request is marked complete. + +### Garbage Collection + +An background garbage collector in the controller scans the account requests, looking for unused requests, which are removed after a configurable amount of time. \ No newline at end of file