aboutsummaryrefslogtreecommitdiff
path: root/README
blob: b4cd0815759b8aaa34435e8117dd1dc0b522a505 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
allium: statically generated tor metrics and statistics - https://yui.cat/

  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

  INSTALL

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

    Files will be generated in the ./www directory by default, configurable by
    editing config.py; the only non-standard dependency is Jinja2>=2.11.2

  TODO

    - top exit/guard/relay families (see https://nusenu.github.io/OrNetStats/)
    - interesting statistics (ASN exit concentration, IPv6-supporting relays)
    - implement something similar to https://metrics.torproject.org/bubbles.html

  note: 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

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