doc/dev/configuration.rst

   1 .. _configuration:
   2
   3 Configuration
   4 =============
   5
   6 The following configuration parameters can be set through environment variables.
   7
   8
   9 General
  10 -------
  11
  12 * ``ADMINS`` - corresponds to `Django's ADMINS setting <https://docs.djangoproject.com/en/dev/ref/settings/#admins>`_. Specified as ``Name <email@host.com>``. Multiple entries can be separated by whitespace.
  13 * ``DEBUG`` - Debug flag, see `Django's DEBUG setting <https://docs.djangoproject.com/en/1.11/ref/settings/#std:setting-DEBUG>`_
  14 * ``DEFAULT_BASE_URL`` - base URL for creating URLs, eg ``https://gpodder.net``
  15 * ``GOOGLE_ANALYTICS_PROPERTY_ID`` - Google Analytics Property ID
  16 * ``MAINTENANCE`` - Maintenance flag
  17 * ``SECRET_KEY`` - see `Django's SECRET_KEY setting <https://docs.djangoproject.com/en/1.11/ref/settings/#secret-key>`_
  18 * ``STAFF_TOKEN`` - token which can be appended to URLs to access staff-only pages
  19 * ``SUPPORT_URL`` - URL where users can get support
  20
  21
  22 Advertising
  23 -----------
  24
  25 * ``ADSENSE_CLIENT`` - Google AdSense Client ID
  26 * ``ADSENSE_SLOT_BOTTOM``- Ad for the ad slot on the bottom of the page
  27 * ``PODCAST_AD_ID`` - Database Id of the podcast which is currently advertising
  28
  29
  30 Celery Task Queue
  31 -----------------
  32
  33 * ``BROKER_POOL_LIMIT`` - corresponds to `Celery's broker_pool_limit setting <http://docs.celeryproject.org/en/latest/userguide/configuration.html#broker-pool-limit>`_. Specifies the maximum number of connections that can be open in the connection pool.
  34 * ``BROKER_URL`` - corresponds to `Celery's broker_url setting <http://docs.celeryproject.org/en/latest/userguide/configuration.html#std:setting-broker_url>`_. Specifies the URL / connection string to the broker.
  35
  36
  37 Caching
  38 -------
  39
  40 The following settings correspond to `Django's CACHE setting
  41 <https://docs.djangoproject.com/en/1.11/ref/settings/#std:setting-CACHES>`_.
  42
  43 * ``CACHE_BACKEND`` - Django cache backend
  44 * ``CACHE_LOCATION`` - Location of the cache
  45
  46
  47 Database
  48 --------
  49
  50 * ``DATABASE_URL`` - Database connection string, see `syntax and options <https://github.com/kennethreitz/dj-database-url>`_.
  51
  52
  53 Emails
  54 ------
  55
  56 * ``DEFAULT_FROM_EMAIL`` - From address for outgoing emails, see `Django's DEFAULT_FROM_EMAIL setting <https://docs.djangoproject.com/en/1.11/ref/settings/#default-from-email>`_.
  57
  58
  59 Search
  60 ------
  61
  62 * ``ELASTICSEARCH_SERVER`` - ``host:port`` of the Elasticsearch server
  63 * ``ELASTICSEARCH_TIMEOUT`` - timeout in seconds for queries to the Elasticsearch server
  64 * ``QUERY_LENGTH_CUTOFF`` - Maximum non-whitespace length of search query
  65
  66
  67 Directory
  68 ---------
  69
  70 * ``DIRECTORY_EXCLUDED_TAGS`` - space-separated list of tags that should be excluded from the podcast directory
  71 * ``SEARCH_CUTOFF`` - minimum search rank (between 0 and 1, default 0.3) below which results are excluded. See `Django's documentation on Weighting queries <https://docs.djangoproject.com/en/1.11/ref/contrib/postgres/search/#weighting-queries>`_
  72
  73
  74 Feeds
  75 -----
  76
  77 * ``FLICKR_API_KEY`` - Flickr API key
  78 * ``SOUNDCLOUD_CONSUMER_KEY`` - Soundcloud Consumer key
  79
  80
  81 Logging
  82 -------
  83
  84 * ``SERVER_EMAIL`` - email address from which error mails are sent, see `Django's SERVER_EMAIL setting <https://docs.djangoproject.com/en/1.11/ref/settings/#server-email>`_
  85 * ``LOGGING_CELERY_HANDLERS`` - space separated list of logging handlers for Celery log events
  86 * ``LOGGING_DJANGO_HANDLERS`` - space separated list of logging handlers for Django log events
  87 * ``LOGGING_MYGPO_HANDLERS`` - space separated list of logging handlers for mygpo log events
  88 * ``LOGGING_FILENAME`` - filename for filesystem logs
  89 * ``LOGGING_DIR_GUNICRON`` - directory for gunicron to log into
  90 * ``OPBEAT_APP_ID`` - Opbeat App ID
  91 * ``OPBEAT_ORGANIZATION_ID`` - Opbeat Organization ID
  92 * ``OPBEAT_SECRET_TOKEN`` - Opbeat Secret Token
  93
  94
  95
  96 Social Login
  97 ------------
  98
  99 * ``GOOGLE_CLIENT_ID`` - Google Client ID
 100 * ``GOOGLE_CLIENT_SECRET`` - Google Client Secret
 101
 102
 103 API
 104 ---
 105 * ``MAX_EPISODE_ACTIONS`` - maximum number of episode actions that the API will return in one `GET` request.