Welcome to froide’s documentation!

Froide is a Freedom of Information portal written in Python using the Django Web framework. It manages contactable entities, requests and much more. Users can send emails to these entities and receive public answers via the platform.

It was developed to power Frag den Staat – the German Freedom of Information Portal, but is internationalized, localized and themeable.

• About
  • Development Goals
  • Features
  • History
  • Name
• Getting Started
  • Set up the development environment
  • Add basic database objects
  • Custom settings
  • Search with Elasticsearch
  • Background Tasks with Celery
• Heroku Deployment
  • Install your Froide instance on Heroku
  • Set up Email Sending and receiving
  • Enable mail attachment storage and faster static file serving
  • Translations
  • Worker Processes
• Importing Public Bodies
  • Prerequisites
  • Format
  • Importing through Admin
  • Importing via command line
• Configuration
  • Froide Configuration
  • Greeting Regexes
  • Index Boosting of Public Bodies
  • Settings for Sending E-Mail
  • Some more settings
  • Securing your site
• Theming Froide
  • Basics
  • URLs
  • Static files
  • Templates
• Froide API
• Development
  • Run tests
  • Build translation
  • Build docs
• Upgrade Descriptions
  • Upgrading from 2.X to 3.X
  • Upgrading from 1.X to 2.X
• Production Setup
  • Protect admin site
  • Acces to Documents

Indices and tables

• Index
• Module Index
• Search Page