docs: document newly added env vars

Author: peter-gy

.env.dev.example

@@ -10,6 +10,12 @@ SECRET_KEY=0738f808b38c82e9c4c16558002aecc1cd1f6480dc5200ad10ca17f7ec41f636
 # Get these from the Google API console
 GOOGLE_CLIENT_ID=
 GOOGLE_CLIENT_SECRET=
+
+# Get theese from the detail page of your GitHub OAuth app
+# Refer to https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app
+GITHUB_CLIENT_ID=
+GITHUB_CLIENT_SECRET=
+
 STEMMAWEB_FRONTEND_URL=http://localhost:8888/stemmaweb/
 
 # Get these from the reCAPTCHA Admin console

.env.example

@@ -9,6 +9,12 @@ SECRET_KEY=7e00ed5d31cd5ee375fa9befcb3b4df60691dec47d0b31aed44331eb7e7d389d
 # Get these from the Google API console
 GOOGLE_CLIENT_ID=
 GOOGLE_CLIENT_SECRET=
+
+# Get theese from the detail page of your GitHub OAuth app
+# Refer to https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app
+GITHUB_CLIENT_ID=
+GITHUB_CLIENT_SECRET=
+
 STEMMAWEB_FRONTEND_URL=http://127.0.0.1:5000
 
 # Get these from the reCAPTCHA Admin console

middleware/.env.example

@@ -1,12 +1,26 @@
-STEMMAREST_ENDPOINT=http://127.0.0.1:8080/stemmarest
-STEMMAWEB_MIDDLEWARE_URL=http://127.0.0.1:3000
+STEMMAREST_ENDPOINT=http://stemmarest:8080/stemmarest
+STEMMAWEB_MIDDLEWARE_URL=http://localhost:8888/stemmaweb/requests
 
-# Generate using `python -c 'import secrets; print(secrets.token_hex())'`
-SECRET_KEY=
+GUNICORN_WORKERS=1
+GUNICORN_BIND=0.0.0.0:3000
 
+# Generated via `python -c 'import secrets; print(secrets.token_hex())'`
+SECRET_KEY=0738f808b38c82e9c4c16558002aecc1cd1f6480dc5200ad10ca17f7ec41f636
+
+# Get these from the Google API console
 GOOGLE_CLIENT_ID=
 GOOGLE_CLIENT_SECRET=
-STEMMAWEB_FRONTEND_URL=http://127.0.0.1:5000
+
+# Get theese from the detail page of your GitHub OAuth app
+# Refer to https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app
+GITHUB_CLIENT_ID=
+GITHUB_CLIENT_SECRET=
+
+STEMMAWEB_FRONTEND_URL=http://localhost:8888/stemmaweb/
+
+# Get these from the reCAPTCHA Admin console
+RECAPTCHA_SITE_KEY=
+RECAPTCHA_SECRET_KEY=
 
 LOG_LEVEL=DEBUG
 LOGFILE=stemmaweb_middleware.log

middleware/README.md

@@ -14,12 +14,16 @@ successfully. As the table below shows, some of these have default values (hence
 required.
 
 | Variable                   | Description                                                                                                                                                                                                      | Default                            |
-|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|
+| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
 | `STEMMAREST_ENDPOINT`      | The URL where the Stemmarest backend is running                                                                                                                                                                  | `http://127.0.0.1:8080/stemmarest` |
 | `STEMMAWEB_MIDDLEWARE_URL` | The URL where this middleware is running                                                                                                                                                                         | `http://127.0.0.1:3000`            |
 | `SECRET_KEY`               | Secret key for the Flask application, used by [Flask-Login](https://github.com/maxcountryman/flask-login).<br />Generate it by executing `python -c 'import secrets; print(secrets.token_hex())'` in your shell. | 🚫                                 |
 | `GOOGLE_CLIENT_ID`         | Google OAuth client ID                                                                                                                                                                                           | 🚫                                 |
 | `GOOGLE_CLIENT_SECRET`     | Google OAuth client secret                                                                                                                                                                                       | 🚫                                 |
+| `GITHUB_CLIENT_ID`         | GitHub OAuth client identifier                                                                                                                                                                                   | 🚫                                 |
+| `GITHUB_CLIENT_SECRET`     | GitHub OAuth client secret                                                                                                                                                                                       | 🚫                                 |
+| `RECAPTCHA_SITE_KEY`       | reCAPTCHA public identifier                                                                                                                                                                                      | 🚫                                 |
+| `RECAPTCHA_SECRET_KEY`     | reCAPTCHA private key                                                                                                                                                                                            | 🚫                                 |
 | `STEMMAWEB_FRONTEND_URL`   | The URL of the frontend. Will be set as the redirect destination after Google OAuth                                                                                                                              | `http://127.0.0.1:5000`            |
 | `LOG_LEVEL`                | Logging verbosity                                                                                                                                                                                                | `DEBUG`                            |
 | `LOGFILE`                  | Destination file to store the logs, relative to this module's root                                                                                                                                               | `stemmaweb_middleware.log`         |
@@ -66,4 +70,4 @@ docker run -it \
 	-e LOGFILE=stemmaweb_middleware.log \
 	-e LOG_BACKTRACE=True \
 	stemmaweb-middleware
-```
+```