https://github.com/asdfdotdev/fail2slack

Keep tabs on your fail2ban jail statuses with Slack.
https://github.com/asdfdotdev/fail2slack

fail2ban python-package python3 slack-webhook

Last synced: about 2 months ago
JSON representation

Keep tabs on your fail2ban jail statuses with Slack.

• Host: GitHub
• URL: https://github.com/asdfdotdev/fail2slack
• Owner: asdfdotdev
• License: gpl-2.0
• Created: 2018-04-21T17:40:57.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2023-05-23T03:22:14.000Z (about 2 years ago)
• Last Synced: 2025-04-10T00:15:44.889Z (about 2 months ago)
• Topics: fail2ban, python-package, python3, slack-webhook
• Language: Python
• Homepage:
• Size: 195 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/funding.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


![Unit Tests](https://github.com/asdfdotdev/fail2slack/workflows/Unit%20Tests/badge.svg) [![codecov](https://codecov.io/gh/asdfdotdev/fail2slack/branch/development/graph/badge.svg)](https://codecov.io/gh/asdfdotdev/fail2slack)  [![downloads](https://img.shields.io/pypi/dm/fail2slack)](https://pypi.org/project/fail2slack)

fail2slack lets you send fail2ban jail status updates to Slack with ease.

## Compatibility

[![Python Version](https://img.shields.io/pypi/pyversions/fail2slack)](https://pypi.org/project/fail2slack) [![Module Version](https://img.shields.io/pypi/v/fail2slack)](https://pypi.org/project/fail2slack)

fail2slack is developed for and tested with recent versions of Python, including:

- 3.7, 3.7.7, 3.8, 3.9, 3.10

[Browse our build history at GitHub.](https://github.com/asdfdotdev/fail2slack/actions)

## Installation

```

pip install fail2slack

```

Install fail2slack using the Python package installer.

[Dependencies for using fail2slack are available in the requirements file.](https://github.com/asdfdotdev/fail2slack/blob/main/requirements.txt)

## Usage

```

usage: __main__.py [-h] [-w WEBHOOK] [-d DELIVERY] [-j JAILS [JAILS ...]] [-i IDENTIFIER]

options:

  -h, --help            show this help message and exit

  -w WEBHOOK, --webhook WEBHOOK

                        Slack webhook URL. Required if delivery method is 1.

  -d DELIVERY, --delivery DELIVERY

                        Delivery method: 0 = print, 1 = Slack webhook.

  -j JAILS [JAILS ...], --jails JAILS [JAILS ...]

                        Jails to include in status report. Required.

  -i IDENTIFIER, --identifier IDENTIFIER

                        Update identifier. STRING of identifier to use. Default is hostname.

```

### Result



## Tests

For instructions on running test check out the [README](https://github.com/asdfdotdev/fail2slack/tree/main/test/#readme).

## Contributing

Feedback, bug reports, feature requests, and pull requests are welcome!

If you'd like to contribute to fail2slack please reference our [code of conduct](https://github.com/asdfdotdev/fail2slack/blob/main/.github/code_of_conduct.md) and [contributing](https://github.com/asdfdotdev/fail2slack/blob/main/.github/contributing.md) guides.