Skip to content

Latest commit

 

History

History
102 lines (66 loc) · 2.29 KB

README.md

File metadata and controls

102 lines (66 loc) · 2.29 KB
Raw

TorStatus

Reboot of famous 🧅 TorStatus project.

🕹 f3l1x.io | 💻 f3l1x | 🐦 @xf3l1x

Info

This is reasearch project to support Tor community. Based on awesome torstatus.rueckgr.at and source codes paulchen/torstatus. Thank you.

Usage

Feel free to clone this project and run your own version.

Requirements

  • VPS
  • Docker
  • Docker Compose
  • Make

Installation

  1. Setup Docker Compose stack.
  • Take a look at our prepared docker-compose.yml.
  • Feel free to edit DB credentials.
  • Torstatus configuration is located at ./torstatus/web/config.php.
  1. Initialize app structure.
  • Create data and confif folders (./_data & ./_config by default).
  • Setup permissions for Tor.
make init
  1. Configure your Tor node.
  • Make a copy of ./docker/tor/torrc file to configure your own Tor node (name, ip, contact, limits, etc).
cp ./docker/tor/torrc ./_config/torrc
  1. Start Docker Compose stack.
# Recommended for the first time
docker-compose up

# Later
docker-compose up -d
  1. Import SQL data.
  • Once MySQL is fully loaded, import tables and first records.
make db-init
  1. Retrive Tor data.
  • You need to fetch data from your Tor node.
  • Run perl script located in ./torstatus/tns_update.pl.
make update
  • It might take a while for the first time.
  1. Open http://IP:8000.

Development

See how to contribute to this package.

This package is currently maintained by these authors.

Consider to support f3l1x. Also thank you for using this package.