aboutsummaryrefslogtreecommitdiff
allium: generate static tor relay metrics and statistics

usage: allium.py [-h] [--out] [--onionoo-url]

optional arguments:
  -h, --help     show this help message and exit
  --out          directory to store rendered files (default "./www")
  --onionoo-url  onionoo HTTP URL (default
                 "https://onionoo.torproject.org/details")

ABOUT

  allium generates a set of HTML documents which represent the total set of tor
  relays at the time of execution

  allium is heavily inspired by the official tor metrics project[0] and serves
  as a javascript-free, statically-generated clean room implementation. the
  primary goals of the project are to be fast (static), use few API queries
  (one), and to present information in a condensed, readable format

REQUIRES

  python3
  Jinja2>=2.11.2

INSTALL

  pip install -r requirements.txt
  cd allium
  ./allium.py

LICENSE

  this project includes country flags from GoSquared[1] and relay flags from the
  Tor Project[2], the licenses of which are included in this project's root
  directory; all code is published under UNLICENSE (public domain)

  [0] https://metrics.torproject.org/
  [1] https://github.com/gosquared/flags
  [2] https://www.torproject.org/