Skip to content
Switch branches/tags

Latest commit



Failed to load latest commit information.
Latest commit message
Commit time
Jun 20, 2018
Apr 17, 2018

Ona Platform

Collect, Analyze and Share Data!


Ona is derived from the excellent formhub platform developed by the Sustainable Engineering Lab at Columbia University.


See the installation documentation.


Install Docker and Docker Compose.

docker-compose up

# create super user
# -----------------
docker exec -it onadata_web_1 bash

# activate virtual envirenment
source /srv/.virtualenv/bin/activate

python createsuperuser

It should be accessible via http://localhost:8000. The settings are in onadata/settings/

On registration check the console for the activation links, the default email backend is django.core.mail.backends.console.EmailBackend. See Django Docs for details.


If you would like to contribute code please read Contributing Code to Ona Data.

Edit top level requirements in the file requirements/ Use
pip-compile to update requirements/base.pip. You will need to update requirements.pip and set lxml==3.6.0, for some unknown reason pip-compile seems to pick a lower version of lxml when openpyxl requires lxml>=3.3.4.
pip-compile --output-file requirements/base.pip requirements/

Copy into .git/hooks/pre-commit, it ensures staged python flake8 are in acceptable code style and conventions.

cp .git/hooks/pre-commit
chmod +x .git/hooks/pre-commit

Security Acknowledgments

We would like to thank the following security researchers for responsibly disclosing security issues:

Name Date Severity Contribution
Danish Tariq 1st April 2018 Medium Users able to create projects in other user accounts

Code Structure

  • api - This app provides the API functionality mostly made up of viewsets
  • logger - This app serves XForms to and receives submissions from ODK Collect and Enketo.
  • viewer - This app provides a csv and xls export of the data stored in logger. This app uses a data dictionary as produced by pyxform. It also provides a map and single survey view.
  • main - This app is the glue that brings logger and viewer together.


To generate a locale from scratch (ex. Spanish) makemessages -l es -e py,html,email,txt ;
for app in {main,viewer} ; do cd onadata/apps/${app} && makemessages -d djangojs -l es && cd - ; done

To update PO files makemessages -a ;
for app in {main,viewer} ; do cd onadata/apps/${app} && makemessages -d djangojs -a && cd - ; done

To compile MO files and update live translations compilemessages ;
for app in {main,viewer} ; do cd onadata/apps/${app} && compilemessages && cd - ; done

Api Documentation

Generate the API documentation and serve via Django using:

cd docs
make html
python collectstatic

Generate sphinx docs for new code using autodoc.

Run sphinx in autobuild mode using:

sphinx-autobuild docs docs/_build/html

Requires sphinx-autobuild, install with pip install sphinx-autobuild.

Django Debug Toolbar

  • $ pip install django-debug-toolbar
  • Use/see onadata/settings/debug_toolbar_settings/py
  • Access api endpoint on the browser and use .debug as the format extension e.g /api/v1/projects.debug

Upgrading existing installation to django 1.9+


  • Postgres 9.4 or higher
  • xcode-select version 2343 or higher

Upgrading from a pervious Ona setup Ensure you upgrade all your pip requirements using the following command:

pip install -r requirements/base.pip

Fake initial migration of guardian, django_digest, registration. Migrate contenttypes app first.

python migrate contenttypes
python migrate --fake-initial django_digest
python migrate --fake-initial guardian
python migrate --fake-initial registration
python migrate

Major django changes affecting Ona * The DATABASES settings key depricates the use of the autocommit setting in the OPTIONS dictionary.