bridgedb.conf

   1
   2 #==========
   3 # General-purpose options.
   4
   5 # We chdir to this directory when we start; all files with relative
   6 # pathnames are created under this directory
   7 RUN_IN_DIR = "~/run/"
   8
   9 # Either a file in which to write our pid, or None
  10 PIDFILE = "bridgedb.pid"
  11
  12 # Files from which we read descriptors on start and SIGHUP
  13 # XXXX SIGHUP not implemented.
  14 BRIDGE_FILES = [ "./cached-descriptors", "./cached-descriptors.new" ]
  15
  16 # Only consider routers whose purpose matches this string.
  17 BRIDGE_PURPOSE = "bridge"
  18 # File to store persistent info in.
  19 DB_FILE = "./bridgedist.db"
  20 # File to log changes to persistent info in.  For debugging and bugfixing.
  21 DB_LOG_FILE = "./bridgedist.log"
  22 # File in which we store our secret HMAC root key.
  23 MASTER_KEY_FILE = "./secret_key"
  24
  25 # How many clusters do we group IPs in when distributing bridges based on IP?
  26 N_IP_CLUSTERS = 4
  27
  28 #==========
  29 # Options related to HTTPS
  30
  31 # True if we are enabling distribution via HTTP or HTTPS; False otherwise.
  32 HTTPS_DIST = True
  33 # What proportion of bridges do we allocate to HTTP distribution?  See
  34 # EMAIL_SHARE and RESERVED_SHARE.
  35 HTTPS_SHARE=10
  36 # An IP address (form "1.2.3.4") where we listen for HTTPS connections.
  37 # "None" to listen on the default interface.
  38 HTTPS_BIND_IP=None
  39 # Port to listen on for incoming HTTPS connections
  40 HTTPS_PORT=3443
  41 # Certificate file
  42 HTTPS_CERT_FILE="cert"
  43 # Private key file.
  44 HTTPS_KEY_FILE="privkey.pem"
  45 # IP and port to listen on for unencrypted HTTP connections. Debugging only.
  46 HTTP_UNENCRYPTED_BIND_IP=None
  47 HTTP_UNENCRYPTED_PORT=None
  48 # How many bridges do we give back in an answer?
  49 HTTPS_N_BRIDGES_PER_ANSWER=2
  50
  51 #==========
  52 # Options related to Email
  53
  54 # True if we are enabling distribution via Email; false otherwise.
  55 EMAIL_DIST = True
  56 # What proportion of bridges do we allocate to Email distribution?  See
  57 # HTTPS_SHARE and RESERVED_SHARE.
  58 EMAIL_SHARE=10
  59 # Canonical versions of domains that we will reply to.
  60 EMAIL_DOMAINS = [ "gmail.com", "yahoo.com" ]
  61 # Map from unofficial domain to canonical domain.
  62 EMAIL_DOMAIN_MAP = { "mail.google.com" : "gmail.com",
  63                      "googlemail.com" : "gmail.com",
  64                      }
  65 # If there are any IPs in this list, only allow incoming connections from
  66 # those IPs.
  67 EMAIL_RESTRICT_IPS=[]
  68 # IP and port to listen on for email connections. Debugging only.
  69 EMAIL_BIND_IP=None
  70 EMAIL_PORT=6725
  71 # How many bridges to we give back in an answer?
  72 EMAIL_N_BRIDGES_PER_ANSWER=2
  73
  74 #==========
  75 # Options related to unallocated bridges.
  76
  77 # We split bridges into a group accessible by HTTPS queries; a group
  78 # accessible by email queries; and a group that we don't assign to any
  79 # query mechanism.  Once a bridge is assigned to either of the first
  80 # two groups, it stays there persistently.  The bridges are allocated
  81 # to these groups in an proportion of
  82 #   HTTPS_SHARE : EMAIL_SHARE : RESERVED_SHARE
  83 RESERVED_SHARE=2
  84
  85