Commit bf3027a8 authored by Matthew Finkel's avatar Matthew Finkel
Browse files

Update the contents and docs of README and .conf

Further describe some config options
Rearrange and regroup some configuration file options
Clarify end-user distributor usage
parent 99cbe98d
......@@ -28,9 +28,10 @@ layer of encryption.
#### So how do I use this?
Well, probably, you don't. But if you're looking for bridges, you can use
[BridgeDB's web interface](https://bridges.torproject.org), which has
instructions on getting the Pluggable Transports Tor Browser Bundle, as well
as instructions for getting extra Bridges.
[the web interface](https://bridges.torproject.org) of the BridgeDB instance
deployed by the Tor Project, which has instructions on getting the Pluggable
Transports-capable Tor Browser Bundle, as well as instructions for getting
extra Bridges.
## Maintainer Setup
......@@ -122,8 +123,8 @@ all the updated files in their correct locations.
**Requesting Translations for Altered/Added Source Code**: This should be done
whenever any of the strings requiring translation -- _("they are formatted
like this") -- are changed, or new ones are added. See
```lib/bridgedb/I18n.py```.
like this") -- are changed, or new ones are added.
See ```lib/bridgedb/I18n.py```.
Translations for Tor Project repos are kept
[in a separate repo](https://gitweb.torproject.org/translation.git). You'll
......@@ -153,7 +154,7 @@ complete, the finished .po files should be placed into the
#### Enabling HTTPS
Create a self-signed certificate with:
maint/make-ssl-cert
scripts/make-ssl-cert
Or, place an existing certificate in the path specified in bridgedb.conf by
the ```HTTPS_CERT_FILE``` option, and a private key where ```HTTPS_KEY_FILE```
......@@ -233,8 +234,10 @@ such as Twitter.
Just connect to the appropriate port.
#### To use with email:
Any mail sent to the email port with a subject or a single line _exactly_
equal to "get bridges" will get answered, assuming the domain is okay.
Any mail sent to the email port with a destination username as defined by the
EMAIL_USERNAME configuration option (default is 'bridge', e.g. bridges@...)
and sent from a yahoo or gmail address (by default, configured with the
EMAIL_DOMAINS option).
### Support
Send your questions to isis (A) torproject (circle) org.
......@@ -101,13 +101,8 @@ DB_LOG_FILE = "bridgedist.log"
# inside are automatically created for you if they do not exist.
MASTER_KEY_FILE = "secret_key"
# Filename that contains blocked bridges list. Comment out to disable.
#COUNTRY_BLOCK_FILE = "blocked-bridges"
# A list of filenames that contain IP addresses (one per line) of proxies.
# All IP-based distributors that see an incoming connection from a proxy
# will treat them specially.
PROXY_LIST_FILES = []
# File to which we dump bridge pool assignments for statistics.
ASSIGNMENTS_FILE = "assignments.log"
#------------------
# Logging Options \
......@@ -126,11 +121,21 @@ SAFELOGGING = True
LOGFILE_COUNT = 5
LOGFILE_ROTATE_SIZE = 10000000
# Only consider routers whose purpose matches this string.
BRIDGE_PURPOSE = "bridge"
#-------------------------------
# General Distribution Options \
#------------------------------------------------------------------------------
#
# These options are not specific to a certain distributor and they may alter
# the bridge selection process in certain circumstances.
#------------------------------------------------------------------------------
# File to which we dump bridge pool assignments for statistics.
ASSIGNMENTS_FILE = "assignments.log"
# Filename that contains blocked bridges list. Comment out to disable.
#COUNTRY_BLOCK_FILE = "blocked-bridges"
# A list of filenames that contain IP addresses (one per line) of proxies.
# All IP-based distributors that see an incoming connection from a proxy
# will treat them specially.
PROXY_LIST_FILES = []
# How many clusters do we group IPs in when distributing bridges based on IP?
# Note that if PROXY_LIST_FILES is set (below), what we actually do here
......@@ -146,6 +151,9 @@ FORCE_PORTS = [(443, 1)]
# Only "Stable" is now supported. This is a list of (flag,minimum) tuples.
FORCE_FLAGS = [("Stable", 1)]
# Only consider routers whose purpose matches this string.
BRIDGE_PURPOSE = "bridge"
#-------------------------------
# HTTP(S) Distribution Options \
#------------------------------------------------------------------------------
......@@ -189,6 +197,18 @@ HTTP_UNENCRYPTED_PORT = None
# unencrypted connections.
HTTP_USE_IP_FROM_FORWARDED_HEADER = False
# How many bridges do we try to give back in an answer by the
# unencrypted HTTP distributor?
HTTP_N_BRIDGES_PER_ANSWER = 3
# Options related to recaptcha support.
# Enable/Disable recaptcha
RECAPTCHA_ENABLED = False
# Recaptcha API keys
RECAPTCHA_PUB_KEY = ''
RECAPTCHA_PRIV_KEY = ''
#-------------------------------
# Email Distribution Options \
#------------------------------------------------------------------------------
......@@ -286,15 +306,5 @@ RESERVED_SHARE = 2
# A dictionary of {FILENAME: NUMBER} where FILENAME is a string specifying the
# filename to store a certain NUMBER (an integer) of bridges in. The number of
# bridges here is *not* a share/proportion, as above; instead it's literally
# the number of bridges.
# the number of bridges. See the ``README`` for more details.
FILE_BUCKETS = {}
# Recaptcha Options
# -----------------
# Enable/Disable recaptcha
RECAPTCHA_ENABLED = False
# Recaptcha API keys
RECAPTCHA_PUB_KEY = ''
RECAPTCHA_PRIV_KEY = ''
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment