From fe37c2cab36478add22111d1ae9a75ad6bba7a06 Mon Sep 17 00:00:00 2001 From: dataprolet <48024821+dataprolet@users.noreply.github.com> Date: Mon, 9 Mar 2026 01:19:39 +0100 Subject: [PATCH] docs: add 'Creating an Account' section to README (#260) Add 'Creating an Account' section to README Added a section about account creation and email verification. Signed-off-by: dataprolet <48024821+dataprolet@users.noreply.github.com> --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 2e8f527..0b80237 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,7 @@ This repository contains configurations and instructions that can be used for de - [Configuration](#configuration) - [Updating](#updating) - [Additional Notes](#additional-notes) + - [Creating an Account](#creating-an-account) - [Placing Behind Another Reverse-Proxy or Another Port](#placing-behind-another-reverse-proxy-or-another-port) - [Insecurely Expose the Database](#insecurely-expose-the-database) - [Mongo Compatibility](#mongo-compatibility) @@ -218,6 +219,11 @@ docker compose up -d ## Additional Notes +### Creating an Account + +By default, email verification is disabled. +However, when you sign up for an account on your Stoat instance, you are still required to submit an email address and will see a prompt to "Check your mail!" for a verification email. You can simply return to the login page and log in using the email address and password you just set. + ### Placing Behind Another Reverse-Proxy or Another Port During configuration using `generate_config.sh` you will be asked if you'd like to place Stoat behind another reverse proxy. Enter `y` to configure for reverse proxy. This will expose your caddy on port 8880, and you can reverse proxy to