Metadata-Version: 2.0
Name: autoguard
Version: 0.2.10
Summary: Configuration setup for sentry
Home-page: https://github.com/Polyconseil/autoguard
Author: Polyconseil
Author-email: opensource+autoguard@polyconseil.fr
License: BSD
Keywords: sentry config
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Topic :: Software Development :: Build Tools
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Requires-Dist: sentry[postgres] (==7.7.0)
Requires-Dist: getconf (>=1.3.0)
Requires-Dist: python-memcached (>=1.54)
Requires-Dist: nydus (<0.11.0,>=0.10.7)
Requires-Dist: python-ldap (>=2.4.19)

autoguard
=========

The ``autoguard`` project is mostly a configuration setup for sentry.

It provides a standardized, easily configurable setup for that project.


Usage
-----

The ``autoguard`` configuration can be tuned in a few ways:

* Specific environment variables (starting with ``AUTOGUARD_``)
* Reading from ``/etc/autoguard/settings.ini``
* On a dev checkout, reading from ``/path/to/autoguard_checkout/local_settings.ini``

All options are described in ``example_settings.ini`` file.

Security
--------

Autoguard expects to run behind a **HTTPS** reverse proxy; that proxy *MUST* set the ``X-Forwarded-Proto`` HTTP header
to ``https`` for HTTPS requests.

The authentication is based on ``X-auth-User`` HTTP header, the proxy *MUST* clean it before passing to the application.


Usage
-----

Run the following commands:

.. code-block:: sh

    $ autoguard upgrade
    $ autoguard createsuperuser
    $ autoguard start
    $ autoguard celery worker -B

The `autoguard` command is equivalent to `sentry --config=./autoguard/sentry_conf.py`.


