Skip to content
This repository has been archived by the owner on Sep 12, 2022. It is now read-only.

docs: Added two env vars to configuration documentation (LLC-285) #86

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: Added two env vars to configuration documentation (LLC-285) #86

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/guides-configuring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ AWS_SQS_DEFAULT_REGION | The AWS region for SQS | `us-west-1` | -
GOOGLE_ENABLED | Enable OAuth via Google (Requires setup in the Google Developer Console) | `true` | `false`
GOOGLE_CLIENT_ID | Google OAuth Client ID | `12456789` | -
GOOGLE_CLIENT_SECRET | Google OAuth Client Secret | `12356789` | -
SERVICE_BUS_ENDPOINT | Azure service bus endpoint, required if QUEUE_PROVIDER=SERVICE_BUS | `Endpoint=sb://[namespace].servicebus.windows.net/;SharedAccessKeyName=[keyName];SharedAccessKey=[key]` -
**FS_REPO** | Define the storage method (`local` for local storage or `amazon` for AWS S3 storage) | `local` | -
FS_SUBFOLDER | A subfolder for all uploads to live within | `storage` | `storage`
FS_LOCAL_ENDPOINT | An absolute path to storage | `/custom/storage/dir` | Current working directory
Expand Down Expand Up @@ -89,6 +90,7 @@ Name | Description | Example | Default
_MODELS_REPO_ | Development setting to pick database type (`mongo` or `memory`). Memory only to be used for testing | `mongo` | `mongo`
**MONGO_URL** | The [full Mongo connection string](https://docs.mongodb.com/manual/reference/connection-string/). This can include multiple hosts for replicas, and extra configuration values passed through query strings. | `mongodb://localhost:27017/learninglocker_v2`
**REDIS_URL** | The full URL of the Redis instance including port, database number and authentication if required | `redis://127.0.0.1:6379/0` | `redis://127.0.0.1:6379/0`
**REDIS_TEST_URL** | The full URL of the Redis instance including port, database number and authentication if required used for Jest tests | `redis://127.0.0.1:6379/1` | `redis://127.0.0.1:6379/1`
REDIS_PREFIX | A prefix to append to all keys within the Redis database | `learninglocker` | -
REDIS_PREFIX | A prefix to append to all keys within the Redis database | `learninglocker` | 'LEARNINGLOCKER'
**STORAGE_REPO** | Define the storage method (`local` for local storage or `s3` for AWS S3 storage) | `local` | -
Expand Down