app.json

{
  "addons": ["heroku-postgresql:hobby-dev", "rediscloud:30"],
  "buildpacks": [
    {
      "url": "https://github.com/heroku/heroku-buildpack-apt"
    },
    {
      "url": "https://github.com/moneymeets/python-poetry-buildpack"
    },
    {
      "url": "https://github.com/heroku/heroku-buildpack-python"
    },
    {
      "url": "https://github.com/heroku/heroku-buildpack-pgbouncer"
    },
    {
      "url": "https://github.com/heroku/heroku-buildpack-nginx"
    }
  ],
  "description": "mit-learn",
  "env": {
    "AI_CACHE_TIMEOUT": {
      "description": "Timeout for AI cache",
      "required": false
    },
    "AI_DEBUG": {
      "description": "Include debug information in AI responses if True",
      "required": false
    },
    "AI_MIT_SEARCH_URL": {
      "description": "URL for AI search agent",
      "required": false
    },
    "AI_MODEL": {
      "description": "Model to use for AI functionality",
      "required": false
    },
    "AI_MODEL_API": {
      "description": "The API used for the AI model",
      "required": false
    },
    "AI_PROXY_CLASS": {
      "description": "Proxy class for AI functionality",
      "required": false
    },
    "AI_PROXY_URL": {
      "description": "URL for AI proxy",
      "required": false
    },
    "AI_PROXY_AUTH_TOKEN": {
      "description": "Auth token for AI proxy",
      "required": false
    },
    "AI_MAX_PARALLEL_REQUESTS": {
      "description": "Max parallel requests/user for AI functionality",
      "required": false
    },
    "AI_TPM_LIMIT": {
      "description": "Tokens/minute limit per user for AI functionality",
      "required": false
    },
    "AI_RPM_LIMIT": {
      "description": "Requests/minute limit per user for AI functionality",
      "required": false
    },
    "AI_BUDGET_DURATION": {
      "description": "Length of time before a user's budget usage resets",
      "required": false
    },
    "AI_MAX_BUDGET": {
      "description": "Max budget per user for AI functionality",
      "required": false
    },
    "AI_ANON_LIMIT_MULTIPLIER": {
      "description": "Multiplier for per-user limit/budget shared by anonymous users",
      "required": false
    },
    "AI_MIT_SEARCH_LIMIT": {
      "description": "Limit parameter value for AI search agent",
      "required": false
    },
    "ALLOWED_HOSTS": {
      "description": "",
      "required": false
    },
    "AWS_ACCESS_KEY_ID": {
      "description": "AWS Access Key for S3 storage.",
      "required": false
    },
    "AWS_SECRET_ACCESS_KEY": {
      "description": "AWS Secret Key for S3 storage.",
      "required": false
    },
    "AWS_STORAGE_BUCKET_NAME": {
      "description": "S3 Bucket name.",
      "required": false
    },
    "BLOCKLISTED_COURSES_URL": {
      "description": "URL of a text file containing blocklisted course ids",
      "required": false
    },
    "DUPLICATE_COURSES_URL": {
      "description": "URL of a text file containing course ids that are duplicates of each other",
      "required": false
    },
    "BOOTCAMPS_URL": {
      "description": "URL to retrieve bootcamps data",
      "required": false
    },
    "CELERY_WORKER_MAX_MEMORY_PER_CHILD": {
      "description": "Max memory to be used by celery worker child",
      "required": false
    },
    "CORS_ALLOWED_ORIGINS": {
      "description": "A list of origins that are authorized to make cross-site HTTP requests",
      "required": false
    },
    "DRF_NESTED_PARENT_LOOKUP_PREFIX": {
      "description": "DRF extensions parent lookup kwarg name prefix",
      "required": false
    },
    "CORS_ALLOWED_ORIGIN_REGEXES": {
      "description": "A list of regexes that match origins that are authorized to make cross-site HTTP requests",
      "required": false
    },
    "CSAIL_BASE_URL": {
      "description": "CSAIL courses base URL",
      "required": false
    },
    "CSRF_COOKIE_DOMAIN": {
      "description": "The domain to set the CSRF cookie on",
      "required": false
    },
    "DEFAULT_SEARCH_MODE": {
      "description": "Default search mode for the search API and frontend",
      "required": false
    },
    "DEFAULT_SEARCH_SLOP": {
      "description": "Default slop value for the search API and frontend. Only used for phrase queries.",
      "required": false
    },
    "DEFAULT_SEARCH_STALENESS_PENALTY": {
      "description": "Default staleness penalty value for the search API and frontend",
      "required": false
    },
    "DEFAULT_SEARCH_MINIMUM_SCORE_CUTOFF": {
      "description": "Default minimum score cutoff value for the search API and frontend",
      "required": false
    },
    "DEFAULT_SEARCH_MAX_INCOMPLETENESS_PENALTY": {
      "description": "Default max incompleteness penalty value for the search API and frontend",
      "required": false
    },
    "DEFAULT_SEARCH_CONTENT_FILE_SCORE_WEIGHT": {
      "description": "Default score weight for content file search match",
      "required": false
    },
    "EDX_API_ACCESS_TOKEN_URL": {
      "description": "URL to retrieve a MITx access token",
      "required": false
    },
    "EDX_API_URL": {
      "description": "URL to retrieve MITx course data from",
      "required": false
    },
    "EDX_API_CLIENT_ID": {
      "description": "EdX client id to access the MITx course catalog API",
      "required": false
    },
    "EDX_API_CLIENT_SECRET": {
      "description": "EdX secret key to access the MITx course catalog API",
      "required": false
    },
    "EDX_ALT_URL": {
      "description": "Base alternate URL for MITx courses hosted on edX",
      "required": false
    },
    "EDX_BASE_URL": {
      "description": "Base default URL for MITx courses hosted on edX",
      "required": false
    },
    "EDX_LEARNING_COURSE_BUCKET_NAME": {
      "description": "Name of the bucket with course run tar archives for MITx",
      "required": false
    },
    "EDX_LEARNING_COURSE_BUCKET_PREFIX": {
      "description": "S3 prefix for MITx bucket keys",
      "required": false
    },
    "EDX_PROGRAMS_API_URL": {
      "description": "The catalog url for MITx programs",
      "required": false
    },
    "OPENSEARCH_HTTP_AUTH": {
      "description": "Basic auth settings for connecting to OpenSearch"
    },
    "OPENSEARCH_CONNECTIONS_PER_NODE": {
      "description": "The size of the connection pool created for each node detected within an OpenSearch cluster.",
      "required": false
    },
    "OPENSEARCH_DEFAULT_TIMEOUT": {
      "description": "The default timeout in seconds for OpenSearch requests",
      "required": false
    },
    "OPENSEARCH_INDEX": {
      "description": "Index to use on OpenSearch",
      "required": true
    },
    "OPENSEARCH_MAX_REQUEST_SIZE": {
      "description": "Maximum size of JSON data requests sent to OpenSearch",
      "required": false
    },
    "OPENSEARCH_SHARD_COUNT": {
      "description": "Number of shards to allocate when creating an OpenSearch index. Generally set to the CPU count of an individual node in the cluster.",
      "required": false
    },
    "OPENSEARCH_REPLICA_COUNT": {
      "description": "Number of index replicas to create when initializing a new OpenSearch index. Generally set to the number of search nodes available in the cluster.",
      "required": false
    },
    "OPENSEARCH_INDEXING_CHUNK_SIZE": {
      "description": "Chunk size to use for OpenSearch indexing tasks",
      "required": false
    },
    "OPENSEARCH_DOCUMENT_INDEXING_CHUNK_SIZE": {
      "description": "Chunk size to use for OpenSearch course document indexing",
      "required": false
    },
    "OPENSEARCH_MAX_SUGGEST_HITS": {
      "description": "Return suggested search terms only if the number of hits is equal to or below this value",
      "required": false
    },
    "OPENSEARCH_MAX_SUGGEST_RESULTS": {
      "description": "The maximum number of search term suggestions to return",
      "required": false
    },
    "OPENSEARCH_MIN_QUERY_SIZE": {
      "description": "Minimimum number of characters in a query string to search for",
      "required": false
    },
    "OPENSEARCH_URL": {
      "description": "URL for connecting to OpenSearch cluster"
    },
    "GA_TRACKING_ID": {
      "description": "Google analytics tracking ID",
      "required": false
    },
    "GA_G_TRACKING_ID": {
      "description": "Google analytics GTM tracking ID",
      "required": false
    },
    "GITHUB_ACCESS_TOKEN": {
      "description": "Access token for the Github API",
      "required": false
    },
    "IMAGEKIT_CACHEFILE_DIR": {
      "description": "Prefix path for cached images generated by imagekit",
      "required": false
    },
    "INDEXING_ERROR_RETRIES": {
      "description": "Number of times to retry an indexing operation on failure",
      "required": false
    },
    "LEARNING_COURSE_ITERATOR_CHUNK_SIZE": {
      "description": "Chunk size for iterating over xPRO/MITx Online courses for master json",
      "required": false
    },
    "MAILGUN_URL": {
      "description": "The URL for communicating with Mailgun"
    },
    "MAILGUN_KEY": {
      "description": "The token for authenticating against the Mailgun API"
    },
    "MAILGUN_FROM_EMAIL": {
      "description": "Email which mail comes from"
    },
    "MAILGUN_BCC_TO_EMAIL": {
      "description": "Email address used with bcc email",
      "required": false
    },
    "MAILGUN_SENDER_DOMAIN": {
      "description": "Domain used for emails sent via mailgun"
    },
    "MAX_S3_GET_ITERATIONS": {
      "description": "Max retry attempts to get an S3 object",
      "required": false
    },
    "MICROMASTERS_CATALOG_API_URL": {
      "description": "URL to MicroMasters catalog API",
      "required": "false"
    },
    "MITPE_BASE_URL": {
      "description": "Base URL for MIT Professional Education website",
      "required": "false"
    },
    "MITX_ONLINE_BASE_URL": {
      "description": "Base default URL for MITx Online courses",
      "required": false
    },
    "MITX_ONLINE_PROGRAMS_API_URL": {
      "description": "The catalog url for MITx Online programs",
      "required": false
    },
    "MITX_ONLINE_COURSES_API_URL": {
      "description": "The api url for MITx Online courses",
      "required": false
    },
    "MITX_ONLINE_LEARNING_COURSE_BUCKET_NAME": {
      "description": "Name of S3 bucket to upload MITx Online course media",
      "required": false
    },
    "MIT_WS_CERTIFICATE": {
      "description": "X509 certificate as a string",
      "required": false
    },
    "MIT_WS_PRIVATE_KEY": {
      "description": "X509 private key as a string",
      "required": false
    },
    "OCW_BASE_URL": {
      "description": "Base URL for OCW courses",
      "required": false
    },
    "OCW_CONTENT_BUCKET_NAME": {
      "description": "Name of S3 bucket containing OCW course data",
      "required": false
    },
    "OCW_ITERATOR_CHUNK_SIZE": {
      "description": "Chunk size for iterating over OCW courses for master json",
      "required": false
    },
    "OCW_LEARNING_COURSE_BUCKET_NAME": {
      "description": "Name of S3 bucket to upload OCW course media",
      "required": false
    },
    "OCW_UPLOAD_IMAGE_ONLY": {
      "description": "Upload course image only instead of all OCW files",
      "required": false
    },
    "OCW_SKIP_CONTENT_FILES": {
      "description": "Skip upserting of OCW content files",
      "required": false
    },
    "OCW_WEBHOOK_DELAY": {
      "description": "Delay in seconds to process an OCW course after receiving webhook",
      "required": false
    },
    "OCW_WEBHOOK_KEY": {
      "description": "Authentication parameter value that should be passed in a webhook",
      "required": false
    },
    "OLL_LEARNING_COURSE_BUCKET_NAME": {
      "description": "Name of S3 bucket containing OLL content files",
      "required": false
    },
    "OLL_LEARNING_COURSE_BUCKET_PREFIX": {
      "description": "Prefix to use with the OLL S3 bucket",
      "required": false
    },
    "MITOL_ADMIN_EMAIL": {
      "description": "E-mail to send 500 reports to.",
      "required": false
    },
    "MITOL_AUTHENTICATION_PLUGINS": {
      "description": "List of pluggy plugins to use for authentication",
      "required": false
    },
    "MITOL_LEARNING_RESOURCES_PLUGINS": {
      "description": "List of pluggy plugins to use for learning resources",
      "required": false
    },
    "MITOL_APP_BASE_URL": {
      "description": "Base url to create links to the app",
      "required": false
    },
    "MITOL_COOKIE_NAME": {
      "description": "Name of the cookie for the JWT auth token",
      "required": false
    },
    "MITOL_COOKIE_DOMAIN": {
      "description": "Domain for the cookie for the JWT auth token",
      "required": false
    },
    "MITOL_DB_CONN_MAX_AGE": {
      "value": "0",
      "required": false
    },
    "MITOL_DB_DISABLE_SSL": {
      "value": "True",
      "required": false
    },
    "MITOL_DB_DISABLE_SS_CURSORS": {
      "description": "Disable server-side cursors",
      "required": false
    },
    "MITOL_EMAIL_HOST": {
      "description": "Outgoing e-mail settings",
      "required": false
    },
    "MITOL_EMAIL_PASSWORD": {
      "description": "Outgoing e-mail settings",
      "required": false
    },
    "MITOL_EMAIL_PORT": {
      "description": "Outgoing e-mail settings",
      "value": "587",
      "required": false
    },
    "MITOL_EMAIL_TLS": {
      "description": "Outgoing e-mail settings",
      "value": "True",
      "required": false
    },
    "MITOL_EMAIL_USER": {
      "description": "Outgoing e-mail settings",
      "required": false
    },
    "MITOL_ENVIRONMENT": {
      "description": "The execution environment that the app is in (e.g. dev, staging, prod)",
      "required": false
    },
    "MITOL_FROM_EMAIL": {
      "description": "E-mail to use for the from field",
      "required": false
    },
    "MITOL_LOG_LEVEL": {
      "description": "The log level for the application",
      "required": false,
      "value": "INFO"
    },
    "MITOL_NEW_USER_LOGIN_URL": {
      "description": "Url to redirect new users to",
      "required": false
    },
    "MITOL_JWT_SECRET": {
      "description": "Shared secret for JWT auth tokens",
      "required": false
    },
    "MITOL_NOINDEX": {
      "description": "Prevent search engines from indexing the site",
      "required": false
    },
    "MITOL_SECURE_SSL_REDIRECT": {
      "description": "Application-level SSL redirect setting.",
      "value": "True",
      "required": false
    },
    "MITOL_SIMILAR_RESOURCES_COUNT": {
      "description": "Number of similar resources to return",
      "required": false
    },
    "MITOL_TITLE": {
      "description": "Title of the MIT Learn site",
      "required": false
    },
    "MITOL_SUPPORT_EMAIL": {
      "description": "Email address listed for customer support",
      "required": false
    },
    "MITOL_UNSUBSCRIBE_TOKEN_MAX_AGE_SECONDS": {
      "description": "Maximum age of unsubscribe tokens in seconds",
      "required": false
    },
    "MITOL_USE_S3": {
      "description": "Use S3 for storage backend (required on Heroku)",
      "value": "False",
      "required": false
    },
    "NEWS_EVENTS_MEDIUM_NEWS_SCHEDULE_SECONDS": {
      "description": "Time in seconds between periodic syncs of Medium MIT News feed",
      "required": false
    },
    "NEWS_EVENTS_SLOAN_NEWS_SCHEDULE_SECONDS": {
      "description": "Time in seconds between periodic syncs of Sloan news",
      "required": false
    },
    "NEWS_EVENTS_OL_EVENTS_SCHEDULE_SECONDS": {
      "description": "Time in seconds between periodic syncs of Open Learning events",
      "required": false
    },
    "OPEN_PODCAST_DATA_BRANCH": {
      "description": "Branch in the open podcast data repository to use for podcast ingestion",
      "required": false
    },
    "OPEN_RESOURCES_MIN_DOC_FREQ": {
      "description": "OpenSearch min_doc_freq value for determining similar resources",
      "required": false
    },
    "OPEN_RESOURCES_MIN_TERM_FREQ": {
      "description": "OpenSearch min_term_freq value for determining similar resources",
      "required": false
    },
    "OPEN_VIDEO_DATA_BRANCH": {
      "description": "Branch in the open video data repository to use for video downloads",
      "required": false
    },
    "OPEN_VIDEO_MAX_TOPICS": {
      "description": "Maximum number of topics to assign a video",
      "required": false
    },
    "OPEN_VIDEO_MIN_DOC_FREQ": {
      "description": "OpenSearch min_doc_freq value for determing video topics",
      "required": false
    },
    "OPEN_VIDEO_MIN_TERM_FREQ": {
      "description": "OpenSearch min_term_freq value for determing video topics",
      "required": false
    },
    "OPEN_VIDEO_USER_LIST_OWNER": {
      "description": "User who will own user lists generated from playlists",
      "required": false
    },
    "NEW_RELIC_APP_NAME": {
      "description": "Application identifier in New Relic."
    },
    "NODE_MODULES_CACHE": {
      "description": "If false, disables the node_modules cache to fix yarn install",
      "value": "false"
    },
    "OCW_NEXT_LIVE_BUCKET": {
      "description": "bucket for ocw-next courses data",
      "required": false
    },
    "OCW_NEXT_AWS_STORAGE_BUCKET_NAME": {
      "description": "bucket for ocw-next storage data",
      "required": false
    },
    "OCW_OFFLINE_DELIVERY": {
      "description": "Enable offline delivery of OCW courses",
      "required": false
    },
    "PGBOUNCER_DEFAULT_POOL_SIZE": {
      "value": "50"
    },
    "PGBOUNCER_MIN_POOL_SIZE": {
      "value": "5"
    },
    "PODCAST_FETCH_SCHEDULE_SECONDS": {
      "description": "The time in seconds between periodic syncs of podcasts",
      "required": false
    },
    "RECAPTCHA_SITE_KEY": {
      "description": "Google Recaptcha site key",
      "required": false
    },
    "RECAPTCHA_SECRET_KEY": {
      "description": "Google Recaptcha secret key",
      "required": false
    },
    "REQUESTS_TIMEOUT": {
      "description": "Default timeout for requests",
      "required": false
    },
    "RSS_FEED_EPISODE_LIMIT": {
      "description": "Number of episodes included in aggregated rss feed",
      "required": false
    },
    "RSS_FEED_CACHE_MINUTES": {
      "description": "Minutes that /podcasts/rss_feed will be cached",
      "required": false
    },
    "SECRET_KEY": {
      "description": "Django secret key.",
      "generator": "secret"
    },
    "SEE_API_ACCESS_TOKEN_URL": {
      "description": "URL to retrieve a MITx access token",
      "required": false
    },
    "SEE_API_URL": {
      "description": "URL to retrieve MITx course data from",
      "required": false
    },
    "SEE_API_CLIENT_ID": {
      "description": "EdX client id to access the MITx course catalog API",
      "required": false
    },
    "SEE_API_CLIENT_SECRET": {
      "description": "EdX secret key to access the MITx course catalog API",
      "required": false
    },
    "SENTRY_DSN": {
      "description": "The connection settings for Sentry"
    },
    "SENTRY_LOG_LEVEL": {
      "description": "The log level for Sentry",
      "required": false
    },
    "STATUS_TOKEN": {
      "description": "Token to access the status API."
    },
    "TIKA_ACCESS_TOKEN": {
      "description": "X-Access-Token value for tika requests",
      "required": false
    },
    "TIKA_OCR_STRATEGY": {
      "description": "OCR strategy to specify in header for tika requests",
      "required": false
    },
    "TIKA_TIMEOUT": {
      "description": "Timeout for tika requests",
      "required": false
    },
    "USE_X_FORWARDED_PORT": {
      "description": "Use the X-Forwarded-Port",
      "required": false
    },
    "USE_X_FORWARDED_HOST": {
      "description": "Use the X-Forwarded-Host",
      "required": false
    },
    "CKEDITOR_ENVIRONMENT_ID": {
      "description": "env ID for CKEditor EasyImage auth",
      "required": false
    },
    "CKEDITOR_SECRET_KEY": {
      "description": "secret key for CKEditor EasyImage auth",
      "required": false
    },
    "CKEDITOR_UPLOAD_URL": {
      "description": "upload URL for CKEditor EasyImage",
      "required": false
    },
    "XPRO_CATALOG_API_URL": {
      "description": "The catalog url for xpro programs",
      "required": false
    },
    "XPRO_COURSES_API_URL": {
      "description": "The api url for xpro courses",
      "required": false
    },
    "XPRO_LEARNING_COURSE_BUCKET_NAME": {
      "description": "Name of S3 bucket to upload xPRO course media",
      "required": false
    },
    "YOUTUBE_DEVELOPER_KEY": {
      "description": "The key to the google youtube api",
      "required": false
    },
    "YOUTUBE_FETCH_SCHEDULE_SECONDS": {
      "description": "The time in seconds between periodic syncs of youtube videos",
      "required": false
    },
    "YOUTUBE_FETCH_TRANSCRIPT_SCHEDULE_SECONDS": {
      "description": "The time in seconds between periodic syncs of youtube video transcripts",
      "required": false
    },
    "SOCIAL_AUTH_OL_OIDC_OIDC_ENDPOINT": {
      "description": "The base URI for OpenID Connect discovery, https://<OIDC_ENDPOINT>/ without .well-known/openid-configuration.",
      "required": false
    },
    "SOCIAL_AUTH_OL_OIDC_KEY": {
      "description": "The client ID provided by the OpenID Connect provider.",
      "required": false
    },
    "SOCIAL_AUTH_OL_OIDC_SECRET": {
      "description": "The client secret provided by the OpenID Connect provider.",
      "required": false
    },
    "SOCIAL_AUTH_ALLOWED_REDIRECT_HOSTS": {
      "description": "The list of additional redirect hosts allowed for social auth.",
      "required": false
    },
    "USERINFO_URL": {
      "description": "Provder endpoint where client sends requests for identity claims.",
      "required": false
    },
    "ACCESS_TOKEN_URL": {
      "description": "Provider endpoint where client exchanges the authorization code for tokens.",
      "required": false
    },
    "AUTHORIZATION_URL": {
      "description": "Provider endpoint where the user is asked to authenticate.",
      "required": false
    },
    "FEATURE_KEYCLOAK_ENABLED": {
      "description": "Authentication functionality is managed by Keycloak.",
      "required": true
    },
    "KEYCLOAK_REALM_NAME": {
      "description": "The Keycloak realm name in which Open Discussions has a client configuration.",
      "required": true
    },
    "KEYCLOAK_BASE_URL": {
      "description": "The base URL for a Keycloak configuration.",
      "required": true
    },
    "POSTHOG_API_HOST": {
      "description": "API host for PostHog",
      "required": false
    },
    "POSTHOG_PROJECT_API_KEY": {
      "description": "Project API key to capture events in PostHog",
      "required": false
    },
    "POSTHOG_PERSONAL_API_KEY": {
      "description": "Private API key to communicate with PostHog",
      "required": false
    },
    "POSTHOG_PROJECT_ID": {
      "description": "PostHog project ID for the application",
      "required": false
    },
    "POSTHOG_TIMEOUT_MS": {
      "description": "Timeout for communication with PostHog API",
      "required": false
    }
  },
  "keywords": ["Django", "Python", "MIT", "Office of Digital Learning"],
  "name": "mit_open",
  "repository": "https://github.com/mitodl/mit-learn",
  "scripts": {
    "postdeploy": "./manage.py migrate --noinput"
  },
  "success_url": "/",
  "website": "https://github.com/mitodl/mit-learn"
}