From f63418039adb733fe3b16dbc2b8ef82db510388d Mon Sep 17 00:00:00 2001
From: Alicia Sykes <alicia@omg.lol>
Date: Thu, 14 Mar 2024 07:59:44 +0000
Subject: [PATCH] Adds docs for rate limit env var

---
 .env              | 11 ++++++-----
 .github/README.md |  6 ++++--
 2 files changed, 10 insertions(+), 7 deletions(-)

diff --git a/.env b/.env
index 8cd3a44..7e40b56 100644
--- a/.env
+++ b/.env
@@ -18,8 +18,9 @@ REACT_APP_WHO_API_KEY=''
 
 # Configuration settings
 # CHROME_PATH='/usr/bin/chromium' # The path the the Chromium executable
-# PORT='3000' # Port to serve the API, when running server.js
-# DISABLE_GUI='false' # Disable the GUI, and only serve the API
-# API_TIMEOUT_LIMIT='10000' # The timeout limit for API requests, in milliseconds
-# API_CORS_ORIGIN='*' # Enable CORS, by setting your allowed hostname(s) here
-# REACT_APP_API_ENDPOINT='/api' # The endpoint for the API (can be local or remote)
+# PORT='3000'                     # Port to serve the API, when running server.js
+# DISABLE_GUI='false'             # Disable the GUI, and only serve the API
+# API_TIMEOUT_LIMIT='10000'       # The timeout limit for API requests, in milliseconds
+# API_CORS_ORIGIN='*'             # Enable CORS, by setting your allowed hostname(s) here
+# API_ENABLE_RATE_LIMIT='true'    # Enable rate limiting for the API
+# REACT_APP_API_ENDPOINT='/api'   # The endpoint for the API (can be local or remote)
diff --git a/.github/README.md b/.github/README.md
index f4caa0b..d9c6f09 100644
--- a/.github/README.md
+++ b/.github/README.md
@@ -839,10 +839,12 @@ Key | Value
 
 Key | Value
 ---|---
-`CHROME_PATH` | The path the Chromium executable (e.g. `/usr/bin/chromium`)
 `PORT` | Port to serve the API, when running server.js (e.g. `3000`)
-`DISABLE_GUI` | Disable the GUI, and only serve the API (e.g. `false`)
+`API_ENABLE_RATE_LIMIT` | Enable rate-limiting for the /api endpoints (e.g. `true`)
 `API_TIMEOUT_LIMIT` | The timeout limit for API requests, in milliseconds (e.g. `10000`)
+`API_CORS_ORIGIN` | Enable CORS, by setting your allowed hostname(s) here (e.g. `example.com`)
+`CHROME_PATH` | The path the Chromium executable (e.g. `/usr/bin/chromium`)
+`DISABLE_GUI` | Disable the GUI, and only serve the API (e.g. `false`)
 `REACT_APP_API_ENDPOINT` | The endpoint for the API, either local or remote (e.g. `/api`)
 
 All values are optional.