aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrederick Muriuki Muriithi2023-10-27 09:14:17 +0300
committerFrederick Muriuki Muriithi2023-10-27 09:25:17 +0300
commitc7372395d459e3cf3dd5a988f2c0705b05f8a537 (patch)
tree32820b1b2958d49743566be56807edbe6a2c04a2
parent12e89deebc6f0ac7f7047b37e5591d8b1e4d2059 (diff)
downloadgn-auth-c7372395d459e3cf3dd5a988f2c0705b05f8a537.tar.gz
Configuration: OAUTH2_SCOPE - provide clarification
Adds clarification that the `OAUTH2_SCOPE` setting is provided by default, and so the final settings are only necessary to override that.
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index 9d11a50..2d4aaa4 100644
--- a/README.md
+++ b/README.md
@@ -35,7 +35,7 @@ variable of the same name as the variable you wish to override.
| `SQL_URI` | MariaDB connections | Used to connect to the MariaDB server |
| `AUTH_DB` | SQLite connections | Used to connect to the Authentication/Authorisation database |
| `AUTH_MIGRATIONS` | Migrations | Relative (to the repo root) path to the migration scripts for the auth(entic/oris)ation database |
-| `OAUTH2_SCOPE` | Supported OAuth2 scope for the application. |
+| `OAUTH2_SCOPE` | Supported OAuth2 scope for the application. | This has some default values provided in the file `gn_auth/settings.py` in this repository. You could narrow the allowable scopes by overriding these. |
There are a few other variables we can set, if we want to customise, or troubleshoot token generation. These are: