Prophecies
APIGithubAbout ICIJAsk for help
  • Introduction
  • Ask for help
  • About ICIJ
  • Github
  • 🌐Getting Started
    • Installation with Docker
    • Key concepts
    • Configure Prophecies
  • ⚡User Guide
    • Upload data as an admin
      • Add a project
      • Add users
      • Add a task
      • Manage a task
    • Check data as a checker
      • Sign in or log in
      • Find a task
      • Read notifications
      • Check records
        • Read tutorial
        • Enter a choice
        • Enter a choice for multiple records
        • Change or cancel a choice
        • Leave a note
        • Open record in new tab
        • Duplicate record
        • Lock record
        • See record's history
      • Search records
      • Filter records
      • Sort records
      • Read shortcuts
      • Read tips
      • Read stats
      • Read history
      • Log out
    • FAQ
  • 🤓Developers
    • Installation from the sources
    • Architecture overview
    • Prophecies API
    • Testing the backend
    • Testing the frontend
    • Continuous integration
    • Publishing a new Docker image
Powered by GitBook

Prophecies is an open source project by the International Consortium of Investigative Journalists

On this page
Export as PDF
  1. Getting Started

Configure Prophecies

The application can be configured using the following environment variables:

Environment Variable
Description
Default Value

SECRET_KEY

Secret key for Django security

'django-insecure-...'

DEBUG

Debug mode toggle

False

TEMPLATE_DEBUG

Debug mode for templates

Value of DEBUG

ALLOWED_HOSTS

Host/domain names that Django can serve

'localhost,127.0.0.1'

CSRF_TRUSTED_ORIGINS

Trusted origins for CSRF protection

'http://localhost:8080'

STATIC_URL

URL for static files

'/static/'

STATIC_ROOT

Directory for collectstatic

Project root + 'run/static'

MEDIA_STORAGE

Type of media storage

'FS'

MEDIA_ROOT

Directory for user-uploaded files

'/media/' for S3, Project root + 'run/media' for FS

MEDIA_URL

URL for media files

'https://{AWS_S3_CUSTOM_DOMAIN}/' for S3, '/media/' for FS

AWS_ACCESS_KEY_ID

AWS access key ID for S3

None

AWS_SECRET_ACCESS_KEY

AWS secret access key for S3

None

AWS_STORAGE_BUCKET_NAME

AWS storage bucket name for S3

None

AWS_S3_REGION_NAME

AWS S3 region name

None

AWS_S3_SIGNATURE_VERSION

AWS S3 signature version

's3v4'

AWS_QUERYSTRING_EXPIRE

AWS query string expiration time

'3600'

DATABASE_URL

Database URL for Django-environ to parse

'sqlite:///{root.path("db.sqlite3")()}'

USE_X_FORWARDED_HOST

Use X-Forwarded-Host header

Value of DEBUG

SOCIAL_AUTH_URL_NAMESPACE

Namespace for social auth URLs

None

SOCIAL_AUTH_LOGIN_URL

Login URL for social auth

'/login/provider/'

SOCIAL_AUTH_PROVIDER_HOSTNAME

Hostname for OAuth provider

None

SOCIAL_AUTH_PROVIDER_KEY

Key for OAuth provider

None

SOCIAL_AUTH_PROVIDER_SECRET

Secret for OAuth provider

None

SOCIAL_AUTH_PROVIDER_PROFILE_URL

Profile URL for OAuth provider

None

SOCIAL_AUTH_PROVIDER_AUTHORIZATION_URL

Authorization URL for OAuth provider

None

SOCIAL_AUTH_PROVIDER_ACCESS_TOKEN_URL

Access token URL for OAuth provider

None

SOCIAL_AUTH_PROVIDER_ACCESS_TOKEN_METHOD

Access token method for OAuth provider

'POST'

SOCIAL_AUTH_PROVIDER_USERNAME_FIELD

Username field for OAuth provider

'username'

SOCIAL_AUTH_PROVIDER_GROUPS_FIELD

Groups field for OAuth provider

'groups'

SOCIAL_AUTH_PROVIDER_STAFF_GROUP

Staff group for OAuth provider

'staff'

CONSTANCE_PUBLIC_KEYS

Comma separated public keys for dynamic settings

'loginUrl'

DJANGO_ADMIN_LOGIN

Toggle for Django Admin native login

Value of DEBUG

CACHE_URL

URL for cache backend

'filecache:///code/prophecies/run/cache/'

DJANGO_LOG_LEVEL

Logging level for Django

'INFO'

PreviousKey conceptsNextUpload data as an admin

Last updated 1 year ago

🌐