4.4. Environment Variables

The page provides a reference guide to the environment variables.

Note

This environment variable documentation is extracted autogmatically from the settings.py file. For this reason, the documentation shows the string “settings.” on the front of each environment variable name. The actual environment variable name is the uppercase string without the “settings.” prefix.

Note

To set the environment variables in a local installation, use OS specific commands. For example, in Unix bash, to set the environment variable MAKAHIKI_EMAIL_INFO:

% export MAKAHIKI_EMAIL_INFO=kukuicup@changeme.com:changeme

To set it in the heroku installation, use the heroku config:add command. For example:

% heroku config:add MAKAHIKI_EMAIL_INFO=kukuicup@changeme.com:changeme

Provides system-level settings and access to environment variables. All variables corresponding to environment variables have documentation for ReadTheDocs.

settings.MAKAHIKI_USE_HEROKU = False

[Optional] If “true”, use Heroku hosting, Otherwise, use local hosting.

settings.MAKAHIKI_DATABASE_URL = ''

[Required if MAKAHIKI_USE_HEROKU is not true] Specify the Database URL. Example: postgres://username:password@db_host:db_port/db_name

settings.MAKAHIKI_ADMIN_INFO = ''

[Required] Specify the makahiki admin account and password. Example: admin:changeme

settings.MAKAHIKI_EMAIL_INFO = ''

[Required if enabling email] Specify the email host user and password. Example: kukuicup@gmail.com:changeme

settings.MAKAHIKI_DEBUG = False

[Optional] If “true”, enable debug mode, with better error messages. Otherwise use production mode.

settings.MAKAHIKI_USE_MEMCACHED = False

[Optional] If “true”, use memcache. Otherwise no caching is used.

settings.MAKAHIKI_USE_S3 = False

[Optional] If “true”, use the Amazon S3 storage facility. Otherwise use local folder.

settings.MAKAHIKI_AWS_ACCESS_KEY_ID = ''

[Required if MAKAHIKI_USE_S3 is true] The Amazon access key ID.

settings.MAKAHIKI_AWS_SECRET_ACCESS_KEY = ''

[Required if MAKAHIKI_USE_S3 is true] The Amazon secret access key.

settings.MAKAHIKI_AWS_STORAGE_BUCKET_NAME = ''

[Required if MAKAHIKI_USE_S3 is true] The Amazon storage bucket name.

settings.MAKAHIKI_USE_LESS = False

[Optional] If “true”, use LESS files to style pages. Otherwise use the latest version of CSS.

settings.MAKAHIKI_LDAP_BIND_DN = ''

[Required for LDAP services] Provide the Bind DN.

settings.MAKAHIKI_LDAP_BIND_PASSWORD = ''

[Required for LDAP services] Provide the Bind password.

settings.MAKAHIKI_LDAP_USE_CN = False

[Optional] If “true”, use the LDAP cn attribute as the username, otherwise use uid attribute.

settings.MAKAHIKI_SECRET_KEY = 'yvzg-s=^gb#)e6l7jq_$%ft=i7jln&izs2@4+3!5%#unumorn-'

[Optional] Specifies the Django secret key setting. See https://docs.djangoproject.com/en/dev/ref/settings/#secret-key

settings.MAKAHIKI_USE_FACEBOOK = False

[Optional] If “true”, use facebook integration.

settings.MAKAHIKI_FACEBOOK_APP_ID = ''

[Required if using Facebook] App ID required for Facebook integration.

settings.MAKAHIKI_FACEBOOK_SECRET_KEY = ''

[Required if using Facebook] Secret key required for Facebook integration.

settings.MAKAHIKI_USE_LOGFILE = False

[Optional] if “true”, use logfile to store application logs.

settings.MAKAHIKI_USE_WATTDEPOT3 = False

[Required if using wattdepot3] wattdepot admin name.

settings.WATTDEPOT_ADMIN_NAME = ''

[Required if using wattdepot3] wattdepot admin password.