From 66a1c97a95aa835e9812c64d1ed03a19f6d31999 Mon Sep 17 00:00:00 2001 From: Pellaeon Lin Date: Sun, 14 Oct 2018 17:42:08 +0800 Subject: [PATCH] Update# documentation --- README.md | 23 ++++++++++++++++------- TESTING.md | 2 ++ 2 files changed, 18 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 0da5be7..1707ce1 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,6 @@ # Registration This app allows users to register a new account. -Flow: - -1. User enters his/her email -2. Verification link is sent to the email address -3. User clicks on the verification link -4. User is lead to a form where one can choose username and password -5. New account is created and is logged in automatically # Requirements 1. ownCloud 9.1.0.7+ @@ -33,6 +26,18 @@ From your Nextcloud instance, click: your profile to the upper right -> Apps -> - Admin can limit the email domains allowed to register - Admin will be notified by email for new user creation +# Web form registration flow + +1. User enters his/her email +2. Verification link is sent to the email address +3. User clicks on the verification link +4. User is lead to a form where one can choose username and password +5. New account is created and is logged in automatically + +# OCS API registration flow + +See https://gist.github.com/juliushaertl/5a1d1132e7370b5ad38fbd6da3cae5b8 + # Donate Send Ethereum to `0x941613eBB948C2C547cb957B55fEB2609fa6Fe66` @@ -43,3 +48,7 @@ Send BTC to `33pStaSaf4sDUA8XBAHTq7ZDQpCVFQArxQ` **Q: A problem occurred sending email, please contact your administrator.** A: your Nextcloud mail configurations or your mail server is incorrectly configured, please refer to the [Nextcloud documentation](https://docs.nextcloud.com/server/11/admin_manual/configuration_server/email_configuration.html). + +# Testing + +See TESTING.md diff --git a/TESTING.md b/TESTING.md index 735f998..126fad0 100644 --- a/TESTING.md +++ b/TESTING.md @@ -1,3 +1,5 @@ +You need a fully working nextcloud/owncloud instance. Check-out this app into the `apps` folder, install the dependencies, and follow the instructions below. The tests will modify your database but should automatically revert the changes in the cleanup stage. + # Dependencies FreeBSD packages: