From 4c4fa3d7264215d5168d1995e1f2b484132ec417 Mon Sep 17 00:00:00 2001 From: Simon Vandevelde Date: Thu, 11 Nov 2021 21:27:44 +0100 Subject: [PATCH] Update README.md with automatic user signup --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 9e825fb..06b9efc 100644 --- a/README.md +++ b/README.md @@ -145,6 +145,14 @@ Docker images named `etesync/test-server:` and `:latest` are available This docker image starts a server on port 3735 that supports user signup (without email confirmation), is in debug mode (thus supporting the reset endpoint), and stores its data locally. It is in no way suitable for production usage, but is able to start up quickly and makes a good component of CI for etesync clients and users of those clients. +# User signup + +Instead of having to create Django users manually when signup up Etebase users, it is also possible to allow automatic signup. +For example, this makes sense when putting an Etebase server in production. +However, this does come with the added risk that everybody with access to your server will be able to sign up. + +In order to set it up, comment out the line `ETEBASE_CREATE_USER_FUNC = "django_etebase.utils.create_user_blocked"` in `server/settings.py` and restart your Etebase server. + # License Etebase is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation. See the [LICENSE](./LICENSE) for more information.