Metadata-Version: 2.1
Name: ghast
Version: 0.0.0
Summary: Graylog HTTP Alert Script Triggerer (ghast)
Home-page: https://github.com/nklapste/ghast
Author: Nathan Klapstein
Author-email: nklapste@ualberta.ca
License: MIT
Keywords: graylog http alert callback script trigger server
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Framework :: Flask
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Server
Requires-Dist: cheroot (<7.0.0,>=6.5.4)
Requires-Dist: flask (<2.0.0,>=1.0.2)
Requires-Dist: flask-restplus (<1.0.0,>=0.12.1)
Provides-Extra: docs
Requires-Dist: sphinx (<2.0.0,>=1.7.5) ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme (<1.0.0,>=0.3.1) ; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints (<2.0.0,>=1.3.0) ; extra == 'docs'
Requires-Dist: sphinx-argparse (<1.0.0,>=0.2.2) ; extra == 'docs'

#####
ghast
#####

.. image:: https://travis-ci.com/nklapste/ghast.svg?token=PXHp9tdymHUxZDzfWpfK&branch=master
    :target: https://travis-ci.com/nklapste/ghast
    :alt: Build Status

Graylog HTTP Alert Script Triggerer (ghast)!

A simple server for triggering a script on a Graylog HTTP alert callback!

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

* Python 3.5+

Installation
============

ghast can be installed via pip:

.. code-block:: bash

    pip install ghast

Example Usage
=============

To start and enable ghast to trigger the script ``./foo.sh`` when a
Graylog HTTP alert callback is sent to the url ``http://localhost:8000/bar``
run the following command:

.. code-block:: bash

    ghast --alert-url /bar --alert-script ./foo.sh

To get additional usage help on ghast run the following console command:

.. code-block:: bash

    ghast --help


