AlbusNoir/fail2banDash

A Flask-driven fail2ban Dashboard

Table of Contents

1. About The Project
   • Languages and Frameworks
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

fail2banDash is just as it sounds: a dashboard for fail2ban. This code can be used as a jumping-off point to add more functionality to it if you want.

Languages and Frameworks

• Flask

Getting Started

Installation

1. Clone the repo

   git clone https://github.com/AlbusNoir/fail2banDash.git
   

2. Create a virtual environment (if that's your thing, otherwise don't)
3. Install requirements

   pip install -r requirements.txt
   

4. Run app.py

   python app.py
   

If you have something else using port 5000 you'll need to edit app.py to use something else. Change the last line in app.py from app.run(host='0.0.0.0') to be app.run(host='0.0.0.0', port=<yourporthere>). If you're running this in production, change debug to False (same place, just one line up in app.py)

Contributing

If you want to make contributions, feel free. I made this for my own limited use case, but I also have other variations that have the ability to edit configs etc, so it's perfectly possible, and if you make your own neat additions, feel free to share them:

1. Fork this fail2banDashsitory
2. Create your Branch(git checkout -b <branch name>)
3. Commit your Changes(git commit -m 'I did some things')
4. Push to the Branch(git push origin <project_name>/<location>)
5. Open a Pull Request

License

Distributed under the GPLv3 License. See LICENSE INFO for more information.