Install Django Project

For detailed local instation instructions, including OS-specific instructions, see the Installation page on the wiki.

  1. Install system packages and libraries. The required packages are Python (2.7, 3.4, or both), pip (latest), and virtualenv (latest). To match production and for a smooth installation of Python packages, install PostgreSQL (9.2 or later recommended) and Memcached (latest). virtualenvwrapper and autoenv will make your development life easier.
  2. Optionally, provision a PostgreSQL database, recommended to match production. The default Django database settings will use a SQLite database named db.sqlite3.
  3. Optionally, run Memcached for improved read performance and to match production. The default settings will run without a cache.
  4. Clone project locally.
  5. Create a virtualenv.
  6. Install dependencies with pip install -r requirements.txt -r requirements-dev.txt.
  7. Customize the configuration with environment variables. See wpcsite/ and env.dist for advice and available settings.
  8. Initialize the database and a superuser account with ./ migrate.
  9. Verify that tests pass with ./manage,py test or make test.
  10. Run it with ./ runserver or ./ runserver_plus.

Install in Heroku

Heroku allows you to quickly deploy web-platform-compat. Heroku hosts the beta version of the service at, using the add-ons:

To deploy with Heroku, you’ll need to signup for a free account and install the Heroku Toolbelt. Then you can:

  1. Clone project locally
  2. heroku apps:create
  3. git push heroku master
  4. See the current config with heroku config, and then customize with environment variables using heroku config:set (see wpcsite/ and env.dist)
  5. Add superuser account (heroku run ./ createsuperuser)

Configuring authentication

The project uses django-allauth as a framework for local and social authentication. The public service uses username and password for local authentication, and Firefox Accounts (FxA) for social authentication.

django-allauth supports multiple emails per user, with one primary email used for communication. Email addresses are validated by sending a confirmation link. For a public server, you’ll need to configure Django to send email, by configuring your mail server and setting environment variables. For local development, it is easiest to print emails to the console:

export EMAIL_BACKEND="django.core.mail.backends.console.EmailBackend"

django-allauth supports many social authentication providers. See the providers documentation for the current list and hints for configuration. Using a authentication provider is not required, especially for local development. Instead, use local authentication with a username and password.

If you need FxA integration, see the Firefox Accounts page on the wiki for install hints.

Load Data

There are several ways to get data into your API:

  1. Load data from the github export
  2. Load data from another webcompat server
  3. Load sample data from the WebPlatform project and MDN

Load from GitHub

The data on is archived in the browsercompat-data github repo, and this is the fastest way to get data into your empty API:

  1. Clone the github repo (git clone
  2. Run the API (./ runserver)
  3. Import the data (tools/ --data /path/to/browsercompat-data/data)

Load from another webcompat server

If you have read access to a webcompat server that you’d like to clone, you can grab the data for your own server.

  1. Download the data (tools/ --api
  2. Run the API (./ runserver)
  3. Import the data (tools/

Load Sample Data

The WebPlatform project imported data from MDN, and stored the formatted compatibility data in a github project. There is a lot of data that was not imported, so it’s not a good data source for re-displaying on MDN. However, combining this data with specification data from MDN will create a good data set for testing the API at scale.

To load sample data:

  1. Run the API (./ runserver)
  2. Load a subset of the WebPlatform data (tools/ or full set of data (tools/ --all-data)
  3. Load specification data (tools/