README

Error reporting tool
===================

This application allows receiving and viewing errors that can be reported when using Yocto project Poky.

Setup
-----

Requirements:

see requirements.txt

Additional if using mysql backend:

* MySQL-python
* libmysqlclient-dev

Recommended:
* virtualenv environment

Setup instructions:

1. Initialise and activate a python virtual environment. `virtualenv venv && source ./venv/bin/activate`
2. Install the dependencies via `pip install -r requirements.txt`
3. Set DATABASES.default.ENGINE in settings.py to use the database engine of your choice.
4. Set a SECRET_KEY in settings.py
5. Setup the database schema with the Django model. Run `python manage.py migrate`.


Usage
-----

To test the server run: `python manage.py runserver`

For production deployment see https://docs.djangoproject.com/en/1.7/howto/deployment/wsgi/modwsgi/

In order to send an error report to the server, run the "send-error-report file_name" script which is available in Yocto project poky scripts directory.

For more information on error reporting and log collection see: http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#using-the-error-reporting-tool

Maintenance
-----------

The code for this application is maintained by the Yocto Project.

The latest version can be checked out by git cloning:

  git://git.yoctoproject.org/error-report-web

Contributions are welcome. Please send patches / pull requests to
yocto@lists.yoctoproject.org with '[error-report-web]' in the subject.

To manage the size of your database there is a convenience command:

Usage: ./manage.py culldb [options] <size>

Culls the database to size in rows

More info ./manage.py culldb --help

! Make sure to have backups of data before deleting/culling !

License
-------

This application is based upon the Django project template, whose files
are covered by the BSD license and are copyright (c) Django Software
Foundation and individual contributors.

Bundled Twitter Bootstrap (including Glyphicons) is redistributed under
the Apache License 2.0.

Bundled jQuery is redistributed under the MIT license.

Bundled jquery.cookie.js is redistributed under the MIT license.

Bundled d3.js is redistributed under the BSD License.

Bundled nvd3.js is redistributed under the Apache License 2.0.

All other content is copyright (C) 2013 Intel Corporation and licensed
under the MIT license (unless otherwise noted) - see COPYING.MIT for
details.