diff --git a/README.md b/README.md index 09758c7..b6edcde 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Registration This app allows users to register a new account. -![Registration form](https://raw.githubusercontent.com/nextcloud/registration/master/appinfo/screenshot.png) +![Registration form](https://raw.githubusercontent.com/nextcloud/registration/master/docs/demo.gif) # Install from appstore @@ -9,9 +9,10 @@ From your Nextcloud instance, click: your profile to the upper right -> Apps -> # Features -- Admins can specify which group the newly created users belong to. -- Admins can limit the email domains allowed to register. -- Admins will be notified via email for new user creation +- Add users to a given group +- Allow-list with email domains (including wildcard) to register with +- Admins will be notified via email for new user creation or require approval +- Supports Nextcloud's Client Login Flow v1 and v2 - Allowing registration in the mobile Apps and Desktop clients # Web form registration flow @@ -23,7 +24,7 @@ From your Nextcloud instance, click: your profile to the upper right -> Apps -> # OCS API registration flow -See https://gist.github.com/juliushaertl/5a1d1132e7370b5ad38fbd6da3cae5b8 +The [OCS Api](https://gist.github.com/juliushaertl/5a1d1132e7370b5ad38fbd6da3cae5b8) is deprecated, use the Nextcloud [Login Flow](https://docs.nextcloud.com/server/stable/developer_manual/client_apis/LoginFlow/index.html) instead. # Donate @@ -36,8 +37,4 @@ You can donate to Pellaeon the original author of the app: **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/latest/admin_manual/configuration_server/email_configuration.html). - -# Testing - -See TESTING.md +A: Your Nextcloud mail settings are incorrectly configured, please refer to the [Nextcloud documentation](https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/email_configuration.html). diff --git a/appinfo/info.xml b/appinfo/info.xml index 7194554..bf2b828 100644 --- a/appinfo/info.xml +++ b/appinfo/info.xml @@ -8,24 +8,20 @@ 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 - # Features -- Admin can specify which group the newly created users belong -- Admin can limit the email domains allowed to register -- Admin will be notified by email for new user creation +- Add users to a given group +- Allow-list with email domains (including wildcard) to register with +- Admins will be notified via email for new user creation or require approval +- Supports Nextcloud's Client Login Flow v1 and v2 - Allowing registration in the mobile Apps and Desktop clients -# Donate +# Web form registration flow -Send Ethereum to `0x941613eBB948C2C547cb957B55fEB2609fa6Fe66` -Send BTC to `33pStaSaf4sDUA8XBAHTq7ZDQpCVFQArxQ` +1. User enters their email address +2. Verification link is sent to the email address +3. User clicks on the verification link +4. User is lead to a form where they can choose their username and password +5. New account is created and is logged in automatically ]]> 0.5.0 agpl @@ -35,7 +31,9 @@ Send BTC to `33pStaSaf4sDUA8XBAHTq7ZDQpCVFQArxQ` https://github.com/nextcloud/registration https://github.com/nextcloud/registration/issues https://github.com/nextcloud/registration - https://raw.githubusercontent.com/nextcloud/registration/master/appinfo/screenshot.png + https://raw.githubusercontent.com/nextcloud/registration/master/docs/screenshot.png + https://raw.githubusercontent.com/nextcloud/registration/master/docs/demo.gif + https://raw.githubusercontent.com/nextcloud/registration/master/docs/admin-settings.png diff --git a/docs/admin-settings.png b/docs/admin-settings.png new file mode 100644 index 0000000..9e554ca Binary files /dev/null and b/docs/admin-settings.png differ diff --git a/docs/demo.gif b/docs/demo.gif new file mode 100644 index 0000000..79e68d9 Binary files /dev/null and b/docs/demo.gif differ diff --git a/appinfo/screenshot.png b/docs/screenshot.png similarity index 100% rename from appinfo/screenshot.png rename to docs/screenshot.png