Monitoring, Reporting, and Logging For Your Tor Relay

- Nightly Email Traffic Reports - mySQL Traffic Logging - Uptime and Connections to be Implemented Soon

View Demo · Report Bug · Request Feature

---

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

A utility made to monitor your tor relay through the inbuilt api. Has SQL logging capabilities and sends nightly HTML fancy email reports updating you on the status of your relay. Fully configurable for local or remote sql and smtp

(back to top)

Built With

• Python
• mySQL
• HTML

(back to top)

Getting Started

Prerequisites

• Running Tor Relay with full access to operator control
• SMTP Server
• mySQL DB and user with read/write access
• Python 3x

Installation/Setup

1. Clone the repo

   git clone https://github.com/algertc/Tor_watchdog.git

2. Edit config.ini (all fields are strings. Do not use quotes.

   ```
   [RELAY_AUTH]
   hashPass = YOUR_RELAY_PASSWORD
   
   [SMTP_AUTH]
   smtpUser = 
   smtpPass = 
   
   [MYSQL]
   host = 
   user = 
   passwd = 
   
   [SMTP_OUTPUT]
   receivingAddr = Address to which the reports should be sent
   

3. Run the main once for testing.

   cd Tor_watchdog
   python3 main.py

4. If all is well, kill the script and run it in background.

   python3 main.py &

5. Done!

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE.txt for more information.

(back to top)