kofal.net/stoatchat-self-hosted
1
0
Fork 1
mirror of https://github.com/stoatchat/self-hosted.git synced 2026-03-19 17:25:17 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: add 'Creating an Account' section to README (#260)

Browse Source 
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>
This commit is contained in:
dataprolet
2026-03-09 01:19:39 +01:00
committed by GitHub
parent aa5c40e477
commit fe37c2cab3
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -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 <http://localhost:8880>