README (2030B)
1 This directory has configuration files that ship with Tor. They include: 2 3 geoip 4 geoip6 5 6 Geoip files for IPv4 and IPv6 7 8 torrc.minimal, torrc.sample: 9 10 generated from torrc.minimal.in and torrc.sample.in by autoconf. 11 12 torrc.minimal.in: 13 14 A very small torrc, suitable for installation by default in 15 /etc/tor/torrc. 16 17 We try to change torrc.minimal.in as infrequently as possible, 18 since doing so makes the users of many packages have to re-build 19 their torrc files. 20 21 22 torrc.minimal.in-staging 23 24 This is where we stage changes to torrc.minimal.in over time so 25 that when we have a change large enough to warrant a new 26 torrc.minimal.in, we can copy all the other changes over 27 wholesale. 28 29 torrc.sample.in: 30 31 A verbose, discursive, batteries-included torrc. Suitable for 32 letting people know how to set up various options, including those 33 most people shouldn't mess with. 34 35 36 ============================== 37 38 On the geoip format: 39 40 Our geoip files are line-oriented. Any empty line, or line starting 41 with a #, is ignored. 42 43 All other lines are composed of three comma-separated values: 44 START,END,CC. For the geoip file, START and END are IPv4 addresses 45 as expressed as 32-bit integers (such as 3325256709 to represent 46 198.51.100.5). For the geoip6 file, START and END are IPv6 47 addresses, with no brackets. In both cases CC is a two-character 48 country code. 49 50 The semantic meaning of a line START,END,CC is that all addresses 51 between START and END _inclusive_ should be mapped to the country code 52 CC. 53 54 We guarantee that all entries within these files are disjoint -- 55 that is, there is no address that is matched by more than one 56 line. We also guarantee that all entries within these files are 57 sorted in numerically ascending order by address. 58 59 Thus, one effective search algorithm here is to perform a binary 60 search on all the entries in the file. 61 62 Note that there _are_ "gaps" in these databases: not every possible 63 address maps to a country code. In those cases, Tor reports the 64 country as ??.