README.md

   1 Tor relay stats
   2 =========
   3
   4 Show various metrics related to tor relays.
   5
   6 Deploy
   7 ====
   8 ```
   9 * Install Pip
  10 $ apt-get install python-dev python-pip
  11 * Use requirements.txt to install dependancies
  12 $ pip install -r requirements.txt
  13 * Install foreman
  14 $ gem install foreman
  15 * Use the Procfile to run the app
  16 $ foreman start
  17 ```
  18
  19 In case you want to use Apache,
  20 ```
  21 $ cat app.wsgi
  22 #!/usr/bin/python
  23
  24 import os, sys
  25 sys.path.append('/path/to/app')
  26
  27 from app import app as application
  28
  29 $ cat /etc/apache2/sites-available/default
  30 WSGIDaemonProcess compass user=nobody group=compass threads=5
  31 WSGIScriptAlias /compass /srv/compass.torproject.org/compass/app.wsgi
  32
  33 <Directory /srv/compass.torproject.org/compass>
  34     WSGIProcessGroup compass
  35     WSGIApplicationGroup %{GLOBAL}
  36     Order deny,allow
  37     Allow from all
  38 </Directory>
  39 ```
  40 License
  41 ===
  42 Licensed under MIT License
  43 (c) Sathyanarayanan Gunasekaran, The Tor Project