README

   1
   2 To set up:
   3  - Install Python 2.4 or later.
   4  - Install Twisted-Web, Twisted-Mail, PyOpenSSL, and all their dependencies.
   5  - To run unit tests, "python setup.py test"
   6  - python setup.py install --prefix=$HOME
   7  - Edit bridgedb.conf; put it somewhere good.
   8  - Make sure that the input files referred to in bridgedb.conf exist.
   9    - You can make a self-signed certificate with
  10      openssl req -x509 -new -nodes > cert
  11  - Set up PYTHONPATH to include "~/lib/python2.4/site-packages/".
  12
  13 To run:
  14  - Run "python -m TorBridgeDB bridgedb.conf"
  15
  16  - When you have new lists of bridges, replace the old files and send the
  17    process a sighup.
  18
  19 To use with HTTPS:
  20  - Just connect to the appropriate port.
  21
  22 To use with email:
  23  - Any mail sent to the email port with a subject or a single line _exactly_
  24    equal to "get bridges" will get answered, assuming the domain is okay.
  25
  26 Support
  27  - Send your questions to nickm.
  28