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  - To generate translation files, run "python setup.py trans" and then run
   8    "python setup.py install_data" to install them
   9  - Edit bridgedb.conf; put it somewhere good.
  10  - Make sure that the input files referred to in bridgedb.conf exist.
  11    - You can make a self-signed certificate with
  12      openssl req -x509 -new -nodes > cert
  13  - Set up PYTHONPATH to include "~/lib/python2.4/site-packages/".
  14
  15 To re-generate the i18n template (in case translation strings have changed
  16 in BridgeDB):
  17  - Run "xgettext lib/bridgedb/I18n.py -dbridgedb -oi18n/templates/bridgedb.pot"
  18
  19 To run:
  20  - Run "python -m TorBridgeDB bridgedb.conf"
  21
  22  - When you have new lists of bridges, replace the old files and send the
  23    process a sighup.
  24
  25 To extract bucket files with unallocated bridges:
  26
  27  -  Edit the configuration file value 'FILE_BUCKETS' according to your needs.
  28     For example, the following is a possible configuration:
  29
  30             FILE_BUCKETS = { "name1": 10, "name2": 15, "foobar": 3 }
  31
  32     This configuration for buckets would result in 3 files being created for
  33     bridge distribution: name1-2010-07-17.brdgs, name2-2010-07-17.brdgs and
  34     foobar-2010-07-17.brdgs. The first file would contain 10 bridges from
  35     BridgeDB's 'unallocated' pool. The second file would contain 15 bridges
  36     from the same pool and the third one similarly 3 bridges. These files can
  37     then be handed out to trusted parties via mail or fed to other distribution
  38     mechanisms such as twitter.
  39
  40 To use with HTTPS:
  41  - Just connect to the appropriate port.
  42
  43 To use with email:
  44  - Any mail sent to the email port with a subject or a single line _exactly_
  45    equal to "get bridges" will get answered, assuming the domain is okay.
  46
  47 Support
  48  - Send your questions to nickm.
  49