oli.example.env

## default administrator
ADMIN_EMAIL=admin@example.edu
ADMIN_PASSWORD=changeme

## Torus public host and port - required for certain functionality such as LTI 1.3 (defaults to localhost)
# SCHEME=https
HOST=localhost
# PORT=443

## Used to specify which port to expose the http server on, but doesnt affect the public url.
## useful for when you are using a proxy and need to run torus on a specific port without changing the
## public url
# HTTP_PORT=80

## HAProxy media routing mode for docker-compose-haproxy.yml
## Use "minio" for local MinIO-backed media routing or "s3" for external media-origin routing
# HA_PROXY_MODE=minio

## Configurable http/https protocol options for cowboy
## https://ninenines.eu/docs/en/cowboy/2.5/manual/cowboy_http/
# HTTP_MAX_HEADER_NAME_LENGTH=64
# HTTP_MAX_HEADER_VALUE_LENGTH=4096
# HTTP_MAX_HEADERS=100

## Change DB_HOST to localhost if running app natively (development only)
DB_HOST=localhost

## Database url with credentials (required for production only)
# DATABASE_URL=ecto://postgres:changeme@postgres/oli

## Set a specific log level at runtime (production only)
# LOG_LEVEL=debug

## Set logger truncation level (in bytes). Defaults to 8192 bytes. To disable trunction, set to "INFINITY".
## See https://hexdocs.pm/logger/Logger.html for details
# LOGGER_TRUNCATE=8192

## Email sending (required for production and dev)
EMAIL_FROM_NAME="OLI Torus"
EMAIL_FROM_ADDRESS="no-reply@example.edu"
# Optional email headers for error handling
# EMAIL_ERRORS_TO_ADDRESS=torus-admin@example.edu
# EMAIL_RETURN_PATH_ADDRESS=torus-admin@example.edu

# ## Help Desk
# HELP_PROVIDER=EmailHelp
# HELP_DESK_EMAIL=help@example.edu
# FRESHDESK_API_KEY=example_api_key
# FRESHDESK_API_URL=https://<domain>.freshdesk.com/api/v2/tickets

# ## OAuth social login (optional to enable social login providers)
# GOOGLE_CLIENT_ID=your_google_client_id
# GOOGLE_CLIENT_SECRET=your_google_client_secret

# AUTHOR_GITHUB_CLIENT_ID=your_author_github_client_id
# AUTHOR_GITHUB_CLIENT_SECRET=your_author_github_client_secret
# USER_GITHUB_CLIENT_ID=your_user_github_client_id
# USER_GITHUB_CLIENT_SECRET=your_user_github_client_secret

# ## Amazon AWS services (required for production)
# AWS_ACCESS_KEY_ID=your_aws_access_key
# AWS_SECRET_ACCESS_KEY=your_aws_secret_access_key
# AWS_REGION=your_aws_region

# ## Minio S3 service (default for development)
# AWS_S3_SCHEME=http
# AWS_S3_HOST=localhost
# AWS_S3_PORT=9000

# ## HAProxy regular Docker variant media origin and backend settings for local dev
# MEDIA_ORIGIN_HOST=media-origin.example.com
# MEDIA_ORIGIN_PORT=80
# TORUS_BACKEND_HOST=host.docker.internal

# ## Amazon S3 service (default for production)
# AWS_S3_SCHEME=https
# AWS_S3_HOST=s3.amazonaws.com
# AWS_S3_PORT=443
# ## If using Amazon S3 service in dev, you will also need to set the MEDIA_URL config accordingly
# S3_MEDIA_BUCKET_NAME=torus-media-dev
# MEDIA_URL=https://torus-media-dev.s3.amazonaws.com

# ## S3 compatable storage service config used for storing and serving media (required for production)
# S3_MEDIA_BUCKET_NAME=torus-media
# MEDIA_URL=https://s3.amazonaws.com

# ## Google recaptcha key and secret (required for production)
# RECAPTCHA_SITE_KEY=some-site-key
# RECAPTCHA_PRIVATE_KEY=some-private-key

# ## Slack integration for notifications
# SLACK_WEBHOOK_URL=your_slack_webhook_url

## Secret key base (required for production)
## You can generate one by calling: mix phx.gen.secret
# SECRET_KEY_BASE=some-secret-key-base

## Live view salt (required for production)
## You can generate one by calling: mix phx.gen.secret
# LIVE_VIEW_SALT=some-live-view-salt

# The key for the cloak vault, used to encrypt and decrypt certain database fields (required)
# This can be generated using a command like: openssl rand -base64 32
CLOAK_VAULT_KEY=HXCdm5z61eNgUpnXObJRv94k3JnKSrnfwppyb60nz6w=

## Path to custom SSL crt and key files. If omitted, a default non-secure one will be used (compile-time config)
# SSL_CERT_PATH=
# SSL_KEY_PATH=

## Enable query analyzer in development (compile-time config, only valid in dev environment)
# DEV_PROBLEMATIC_QUERY_DETECTION_ENABLED=false

# # Number of node instances the Elixir-NodeJS bridge will use, for development purposes, 1 should be fine
# NODE_JS_POOL_SIZE=1

# # Screen idle time out time in seconds. Currently, it's set to 30 minutes
# SCREEN_IDLE_TIMEOUT_IN_SECONDS=1800

# Specify a path to local NodeJS install (required if node is not in './priv/node' or './priv/node/node_modules')
#NODE_PATH=/usr/bin/node

# ## Branding names and assets
# BRANDING_NAME="OLI Torus"
# BRANDING_LOGO="/images/oli_torus_logo.png"

# # BRANDING_LOGO_DARK will fallback to BRANDING_LOGO if one is not specified
# BRANDING_LOGO_DARK="/images/oli_torus_logo_dark.png"
# BRANDING_FAVICONS_DIR="/favicons"

## Configure a payment provider
#PAYMENT_PROVIDER=none

## Configure stripe payment provider
#STRIPE_PUBLIC_SECRET=some-secret
#STRIPE_PRIVATE_SECRET=some-secret

## Configure cashnet payment provider
# CASHNET_STORE=some-number
# CASHNET_CHECKOUT_URL=some-url
# CASHNET_CLIENT=some-name
# CASHNET_NAME=some-name
# CASHNET_GL_NUMBER=some-gl-number

## Blackboard application Client ID
#BLACKBOARD_APPLICATION_CLIENT_ID=some-client-id

## Configure Knowledgebase URL
KNOWLEDGEBASE_URL="#"

## Configure Privacy Policies
#PRIVACY_POLICIES_URL=https://www.cmu.edu/legal/privacy-notice.html

# Configure footer text and links
# FOOTER_TEXT=
# FOOTER_LINK_1_LOCATION=
# FOOTER_LINK_1_TEXT=
# FOOTER_LINK_2_LOCATION=
# FOOTER_LINK_2_TEXT=

## Configure if the application is in load testing mode
# LOAD_TESTING_MODE=false

# Configure if age verification checkbox appears on learner account creation
# IS_AGE_VERIFICATION_ENABLED=

# Configure the exact implementation of the variable substitution transformer, and properties
# VARIABLE_SUBSTITUTION_PROVIDER=RestImpl
# VARIABLE_SUBSTITUTION_REST_ENDPOINT_URL=https://echo.oli.cmu.edu/sandbox

# Configure libcluster for horizontal scaling
# LIBCLUSTER_STRATEGY=
# If using ec2 strategy
# LIBCLUSTER_EC2_STRATEGY_TAG_NAME=
# LIBCLUSTER_EC2_STRATEGY_TAG_VALUE=
# LIBCLUSTER_EC2_STRATEGY_APP_PREFIX=oli

# Configure open ai for DOT AI BOT assistant
# OPENAI_API_KEY= find it at https://platform.openai.com/account/api-keys
# OPENAI_ORG_KEY= find it at https://platform.openai.com/account/org-settings under "Organization ID"

## Configure whether incomplete http requests reported by cowboy should be logged or not
# LOG_INCOMPLETE_HTTP_REQUESTS=true

## Configure Appsignal
# APPSIGNAL_PUSH_API_KEY=
# APPSIGNAL_ENABLE_LOGGING=false

## Configure student sign in background color
# STUDENT_SIGNIN_BACKGROUND_COLOR=#FF82E4

## Configure Certificates
# CERTIFICATES_GENERATE_PDF_LAMBDA=name-of-the-lambda-that-generates-certificates-pdf
# CERTIFICATES_S3_PDF_URL=name-of-the-s3-bucket-where-certificates-are-stored

## Suppress emitting XAPI events (for local development/testing only)
# SUPPRESS_DEV_EVENT_EMITTING=true

## XAPI Analytics ETL Pipeline Configuration
## Set XAPI_ETL_MODE to 'lambda' to use AWS Lambda ETL pipeline instead of direct ClickHouse upload
## Useful for development testing of production ETL pipeline
# XAPI_ETL_MODE=clickhouse
# XAPI_LAMBDA_FUNCTION_NAME=xapi-etl-processor-dev

## ClickHouse Configuration for Lambda ETL (when using XAPI_ETL_MODE=lambda)
## For development with ngrok: set CLICKHOUSE_HOST to your ngrok URL
# CLICKHOUSE_HOST=localhost
# CLICKHOUSE_HTTP_PORT=8123
# CLICKHOUSE_NATIVE_PORT=9090
# CLICKHOUSE_QUERY_USER=oli_analytics_ro
# CLICKHOUSE_QUERY_PASSWORD=password
# CLICKHOUSE_ADMIN_USER=default
# CLICKHOUSE_ADMIN_PASSWORD=password
# CLICKHOUSE_DATABASE=default

# Optional overrides for the ClickHouse inventory backfill S3 endpoint
# CLICKHOUSE_INVENTORY_MANIFEST_BUCKET=torus-xapi-dev-inventory
# CLICKHOUSE_INVENTORY_MANIFEST_PREFIX=inventory/torus-xapi-dev
# CLICKHOUSE_INVENTORY_MANIFEST_HOST=s3.amazonaws.com
# CLICKHOUSE_INVENTORY_MANIFEST_SCHEME=https
# CLICKHOUSE_INVENTORY_MANIFEST_PORT=443
# CLICKHOUSE_INVENTORY_MANIFEST_PAGE_SIZE=2000
# CLICKHOUSE_INVENTORY_MANIFEST_ACCESS_KEY_ID=example-access-key
# CLICKHOUSE_INVENTORY_MANIFEST_SECRET_ACCESS_KEY=example-secret-key
# CLICKHOUSE_INVENTORY_MANIFEST_SESSION_TOKEN=optional-session-token

# Local development only. Do not set this in production.
# PROJECT_EXPORT_LOCAL_OUTPUT_DIR=/path/to/export_directory