docs: add docs for the AWS_COGNITO_DISABLED parameter

mblackgeo · May 6, 2022 · 26b2439 · 26b2439
1 parent fcafc51
commit 26b2439
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/docs/config.md b/docs/config.md
@@ -6,6 +6,7 @@ The following key/value pairs are used for configurating the extension:
 
 | **Config Name**                       | **Description**                                                                          |
 |---------------------------------------|------------------------------------------------------------------------------------------|
+| `AWS_COGNITO_DISABLED`                | Globally disable auth with Cognito (default=False)                                       |
 | `AWS_REGION`                          | Region the user pool was created                                                         |
 | `AWS_COGNITO_DOMAIN`                  | The domain name of the user pool                                                         |
 | `AWS_COGNITO_USER_POOL_ID`            | The ID of the user pool                                                                  |

diff --git a/example/app.py b/example/app.py
@@ -29,6 +29,7 @@ class Config:
     FLASK_ENV = "TESTING"
 
     # Cognito config
+    # AWS_COGNITO_DISABLED = True  # Can set to turn off auth (e.g. for local testing)
     AWS_REGION = environ["AWS_REGION"]
     AWS_COGNITO_USER_POOL_ID = environ["AWS_COGNITO_USER_POOL_ID"]
     AWS_COGNITO_DOMAIN = environ["AWS_COGNITO_DOMAIN"]