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 extract bucket files with unallocated bridges:
  20
  21  -  Edit the configuration file value 'FILE_BUCKETS' according to your needs.
  22     For example, the following is a possible configuration:
  23
  24             FILE_BUCKETS = { "name1": 10, "name2": 15, "foobar": 3 }
  25
  26     This configuration for buckets would result in 3 files being created for
  27     bridge distribution: name1-2010-07-17.brdgs, name2-2010-07-17.brdgs and
  28     foobar-2010-07-17.brdgs. The first file would contain 10 bridges from
  29     BridgeDB's 'unallocated' pool. The second file would contain 15 bridges
  30     from the same pool and the third one similarly 3 bridges. These files can
  31     then be handed out to trusted parties via mail or fed to other distribution
  32     mechanisms such as twitter.
  33
  34 To use with HTTPS:
  35  - Just connect to the appropriate port.
  36
  37 To use with email:
  38  - Any mail sent to the email port with a subject or a single line _exactly_
  39    equal to "get bridges" will get answered, assuming the domain is okay.
  40
  41 Support
  42  - Send your questions to nickm.
  43