README.md: Add guide to set APP_IP_MASK variable

hspsh · Oct 23, 2024 · 301ef19 · 301ef19
1 parent a5105ab
commit 301ef19
Showing 1 changed file with 10 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -27,11 +27,18 @@ poetry run python helpers/db_create.py
 
 ### Setup Environment Variables
 
-Set the `SECRET_KEY` variable:
+Set the following environment variables:
 
-Windows: `set SECRET_KEY=example123`.
+1. `SECRET_KEY`
+2. `APP_IP_MASK` - A mask that filters the allowed IP's, allowing blocking
+   requests outside of the accepted network. For the local development purposes
+   this can be set to `127.0.0.1` to allow requests only from the host machine.
 
-Linux: `export SECRET_KEY=example123`.
+Example of setting environemnt variables:
+
+- Windows: `set SECRET_KEY=example123`.
+
+- Linux: `export SECRET_KEY=example123`.
 
 ### Launch the web server