===================
Lapwing.Org: Cupola
===================

About
=====

Cupola is (currently) a
lightweight version of `Sentry <https://github.com/getsentry/sentry>`_.

The aim is to log web application exceptions,
in both the server side and client side.


Requirements
============

Software
--------

- Python 3 (3.5 or greater)
- PostgreSQL (9.5 or greater)
- Redis (2.6 or greater)


Hardware
--------

- 512MB RAM
- 1CPU core
- Storage requirement will depend on the number of projects,
  number and frequecy of events
  and the length of time you wish to keep records.
  5GB or so will likely be plenty for most use cases.


ChangeLog
=========

See CHANGELOG.rst.


TODO (probably)
===============

#. Add ``collectd`` style logging of servers/VMs.
#. Add cloud VM (OpenStack, DigitalOcean, etc) creation/listing.
#. Add Ansible support.


Licence
=======

Cupola is Copyright (C) 2015-2017 Sam Black samwwwblack@lapwing.org.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.
If not, see `http://www.gnu.org/licenses/ <http://www.gnu.org/licenses/>`_.