added tor man page and link
Geoff Goodell commited on 2005-02-15 23:00:30
Zeige 2 geänderte Dateien mit 464 Einfügungen und 0 Löschungen.
- documentation.html bb05ead2e..5de11d498
- tor.manual.html 000000000..5402b3f0e
| ... | ... |
@@ -72,6 +72,10 @@ developers enough information to build a compatible version of Tor:</p> |
| 72 | 72 |
<li><a href="cvs/tor/doc/control-spec.txt">Tor UI control specification</a></li> |
| 73 | 73 |
</ul> |
| 74 | 74 |
|
| 75 |
+<p>The <a href="/tor.manual.html"><b>manual</b></a> provides detailed |
|
| 76 |
+instructions for how to install and use Tor, including configuration of client |
|
| 77 |
+and server options.</p> |
|
| 78 |
+ |
|
| 75 | 79 |
<p>Look at the <a href="http://freehaven.net/~arma/21c3-slides.pdf">slides |
| 76 | 80 |
from the 21C3 talk</a>. For something more obsolete, |
| 77 | 81 |
look at the <a href="slides-codecon04/">slides from the Codecon |
| ... | ... |
@@ -0,0 +1,460 @@ |
| 1 |
+Content-type: text/html |
|
| 2 |
+ |
|
| 3 |
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
|
| 4 |
+<HTML><HEAD><TITLE>Man page of TOR</TITLE> |
|
| 5 |
+</HEAD><BODY> |
|
| 6 |
+<H1>TOR</H1> |
|
| 7 |
+Section: Maintenance Commands (8)<BR>Updated: November 2004<BR><A HREF="#index">Index</A> |
|
| 8 |
+<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR> |
|
| 9 |
+ |
|
| 10 |
+<A NAME="lbAB"> </A> |
|
| 11 |
+<H2>NAME</H2> |
|
| 12 |
+ |
|
| 13 |
+tor - The second-generation onion router |
|
| 14 |
+<A NAME="lbAC"> </A> |
|
| 15 |
+<H2>SYNOPSIS</H2> |
|
| 16 |
+ |
|
| 17 |
+<B>tor</B> |
|
| 18 |
+ |
|
| 19 |
+[<I>OPTION value</I>]... |
|
| 20 |
+<A NAME="lbAD"> </A> |
|
| 21 |
+<H2>DESCRIPTION</H2> |
|
| 22 |
+ |
|
| 23 |
+<I>tor</I> |
|
| 24 |
+ |
|
| 25 |
+is a connection-oriented anonymizing communication |
|
| 26 |
+service. Users choose a source-routed path through a set of nodes, and |
|
| 27 |
+negotiate a "virtual circuit" through the network, in which each node |
|
| 28 |
+knows its predecessor and successor, but no others. Traffic flowing down |
|
| 29 |
+the circuit is unwrapped by a symmetric key at each node, which reveals |
|
| 30 |
+the downstream node. |
|
| 31 |
+<P> |
|
| 32 |
+ |
|
| 33 |
+Basically <I>tor</I> provides a distributed network of servers ("onion |
|
| 34 |
+routers"). Users bounce their TCP streams -- web traffic, ftp, ssh, etc -- |
|
| 35 |
+around the routers, and recipients, observers, and even the routers |
|
| 36 |
+themselves have difficulty tracking the source of the stream. |
|
| 37 |
+<A NAME="lbAE"> </A> |
|
| 38 |
+<H2>OPTIONS</H2> |
|
| 39 |
+ |
|
| 40 |
+<B>-h, -help</B> |
|
| 41 |
+Display a short help message and exit. |
|
| 42 |
+<DL COMPACT> |
|
| 43 |
+<DT><B>-f </B><I>FILE</I><DD> |
|
| 44 |
+FILE contains further "option value" pairs. (Default: /etc/tor/torrc) |
|
| 45 |
+<DT>Other options can be specified either on the command-line (<I>--option<DD> |
|
| 46 |
+value</I>), or in the configuration file (<I>option value</I>). |
|
| 47 |
+Options are case-insensitive. |
|
| 48 |
+<DT><B>Log </B><I>minSeverity</I>[-<I>maxSeverity</I>] <B>stderr</B>|<B>stdout</B>|<B>syslog</B><DD> |
|
| 49 |
+Send all messages between <I>minSeverity</I> and <I>maxSeverity</I> to |
|
| 50 |
+the standard output stream, the standard error stream, or to the system |
|
| 51 |
+log. (The "syslog" value is only supported on Unix.) Recognized |
|
| 52 |
+severity levels are debug, info, notice, warn, and err. If only one |
|
| 53 |
+severity level is given, all messages of that level or higher will be |
|
| 54 |
+sent to the listed destination. |
|
| 55 |
+<DT><B>Log </B><I>minSeverity</I>[-<I>maxSeverity</I>] <B>file</B> <I>FILENAME</I><DD> |
|
| 56 |
+As above, but send log messages to the listed filename. The "Log" |
|
| 57 |
+option may appear more than once in a configuration file. Messages |
|
| 58 |
+are sent to all the logs that match their severity level. |
|
| 59 |
+<DT><B>BandwidthRate </B><I>N</I> <B>bytes</B>|<B>KB</B>|<B>MB</B>|<B>GB</B>|<B>TB</B><DD> |
|
| 60 |
+A token bucket limits the average incoming bandwidth on this node to |
|
| 61 |
+the specified number of bytes per second. (Default: 780 KB) |
|
| 62 |
+<DT><B>BandwidthBurst </B><I>N</I> <B>bytes</B>|<B>KB</B>|<B>MB</B>|<B>GB</B>|<B>TB</B><DD> |
|
| 63 |
+Limit the maximum token bucket size (also known as the burst) to the given number of bytes. (Default: 48 MB) |
|
| 64 |
+<DT><B>DataDirectory </B><I>DIR</I><DD> |
|
| 65 |
+Store working data in DIR (Default: /var/lib/tor) |
|
| 66 |
+<DT><B>DirServer </B><I>address:port fingerprint</I><DD> |
|
| 67 |
+Use a nonstandard authoritative directory server at the provided |
|
| 68 |
+address and port, with the specified key fingerprint. This option can |
|
| 69 |
+be repeated many times, for multiple authoritative directory |
|
| 70 |
+servers. If no <B>dirserver</B> line is given, Tor will use the default |
|
| 71 |
+directory servers: moria1, moria2, and tor26. |
|
| 72 |
+<DT><B>Group </B><I>GID</I><DD> |
|
| 73 |
+On startup, setgid to this user. |
|
| 74 |
+<DT><B>HttpProxy</B> <I>host</I>[:<I>port</I>]<DD> |
|
| 75 |
+If set, Tor will make all its directory requests through this host:port, |
|
| 76 |
+rather than connecting directly to any directory servers. |
|
| 77 |
+<DT><B>KeepalivePeriod </B><I>NUM</I><DD> |
|
| 78 |
+To keep firewalls from expiring connections, send a padding keepalive |
|
| 79 |
+cell on open connections every NUM seconds. (Default: 5 minutes.) |
|
| 80 |
+<DT><B>MaxConn </B><I>NUM</I><DD> |
|
| 81 |
+Maximum number of simultaneous sockets allowed. You probably don't need |
|
| 82 |
+to adjust this. (Default: 1024) |
|
| 83 |
+<DT><B>OutboundBindAddress </B><I>IP</I><DD> |
|
| 84 |
+Make all outbound connections originate from the IP address specified. This |
|
| 85 |
+is only useful when you have multiple network interfaces, and you want all |
|
| 86 |
+of Tor's outgoing connections to use a single one. |
|
| 87 |
+<DT><B>PIDFile </B><I>FILE</I><DD> |
|
| 88 |
+On startup, write our PID to FILE. On clean shutdown, remove FILE. |
|
| 89 |
+<DT><B>RunAsDaemon </B><B>0</B>|<B>1</B><DD> |
|
| 90 |
+If 1, Tor forks and daemonizes to the background. (Default: 0) |
|
| 91 |
+<DT><B>User </B><I>UID</I><DD> |
|
| 92 |
+On startup, setuid to this user. |
|
| 93 |
+<DT><B>ControlPort </B><I>Port</I><DD> |
|
| 94 |
+If set, Tor will accept connections from the same machine (localhost only) on |
|
| 95 |
+this port, and allow those connections to control the Tor process using the |
|
| 96 |
+Tor Control Protocol (described in control-spec.txt). Note: unless you also |
|
| 97 |
+specify one of <B>HashedControlPassword</B> or <B>CookieAuthentication</B>, |
|
| 98 |
+setting this option will cause Tor to allow any process on the local host to |
|
| 99 |
+control it. |
|
| 100 |
+<DT><B>HashedControlPassword </B><I>hashed_password</I><DD> |
|
| 101 |
+Don't allow any connections on the control port except when the other process |
|
| 102 |
+knows the password whose one-way hash is <I>hashed_password</I>. You can |
|
| 103 |
+compute the hash of a password by running "tor --hash-password |
|
| 104 |
+<I>password</I>". |
|
| 105 |
+<DT><B>CookieAuthentication </B><B>0</B>|<B>1</B><DD> |
|
| 106 |
+If this option is set to 1, don't allow any connections on the control port |
|
| 107 |
+except when the connecting process knows the contents of a file named |
|
| 108 |
+"control_auth_cookie", which Tor will create in its data directory. This |
|
| 109 |
+authentication methods should only be used on systems with good filesystem |
|
| 110 |
+security. |
|
| 111 |
+<B>DirFetchPeriod </B><I>N</I> <B>seconds</B>|<B>minutes</B>|<B>hours</B>|<B>days</B>|<B>weeks</B> |
|
| 112 |
+Every time the specified period elapses, Tor downloads a directory. |
|
| 113 |
+A directory contains a signed list of all known servers as well as |
|
| 114 |
+their current liveness status. (Default: 1 hour) |
|
| 115 |
+<DT><B>StatusFetchPeriod </B><I>N</I> <B>seconds</B>|<B>minutes</B>|<B>hours</B>|<B>days</B>|<B>weeks</B><DD> |
|
| 116 |
+Every time the specified period elapses, Tor downloads signed status |
|
| 117 |
+information about the current state of known servers. (Default: 20 minutes.) |
|
| 118 |
+<DT><B>RendPostPeriod </B><I>N</I> <B>seconds</B>|<B>minutes</B>|<B>hours</B>|<B>days</B>|<B>weeks</B><DD> |
|
| 119 |
+Every time the specified period elapses, Tor uploads any rendezvous |
|
| 120 |
+service descriptors to the directory servers. This information is also |
|
| 121 |
+uploaded whenever it changes. (Default: 20 minutes.) |
|
| 122 |
+<P> |
|
| 123 |
+</DL> |
|
| 124 |
+<A NAME="lbAF"> </A> |
|
| 125 |
+<H2>CLIENT OPTIONS</H2> |
|
| 126 |
+ |
|
| 127 |
+<P> |
|
| 128 |
+ |
|
| 129 |
+The following options are useful only for clients (that is, if <B>SOCKSPort</B> is non-zero): |
|
| 130 |
+<DL COMPACT> |
|
| 131 |
+<DT><B>AllowUnverifiedNodes</B> <B>entry</B>|<B>exit</B>|<B>middle</B>|<B>introduction</B>|<B>rendezvous</B>|...<DD> |
|
| 132 |
+Where on our circuits should we allow Tor servers that the directory |
|
| 133 |
+servers haven't authenticated as "verified"? (Default: middle,rendezvous.) |
|
| 134 |
+<DT><B>ClientOnly </B><B>0</B>|<B>1</B><DD> |
|
| 135 |
+If set to 1, Tor will under no circumstances run as a server. (Usually, |
|
| 136 |
+you don't need to set this; Tor is pretty smart at figuring out whether |
|
| 137 |
+you are reliable and high-bandwidth enough to be a good server.) |
|
| 138 |
+<DT><B>EntryNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD> |
|
| 139 |
+A list of preferred nodes to use for the first hop in the circuit, if possible. |
|
| 140 |
+<DT><B>ExitNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD> |
|
| 141 |
+A list of preferred nodes to use for the last hop in the circuit, if possible. |
|
| 142 |
+<DT><B>ExcludeNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD> |
|
| 143 |
+A list of nodes to never use when building a circuit. |
|
| 144 |
+<DT><B>StrictExitNodes </B><B>0</B>|<B>1</B><DD> |
|
| 145 |
+If 1, Tor will never use any nodes besides those listed in "exitnodes" for |
|
| 146 |
+the last hop of a circuit. |
|
| 147 |
+<DT><B>StrictEntryNodes </B><B>0</B>|<B>1</B><DD> |
|
| 148 |
+If 1, Tor will never use any nodes besides those listed in "entrynodes" for |
|
| 149 |
+the first hop of a circuit. |
|
| 150 |
+<DT><B>FascistFirewall </B><B>0</B>|<B>1</B><DD> |
|
| 151 |
+If 1, Tor will only create outgoing connections to ORs running on ports that |
|
| 152 |
+your firewall allows (defaults to 80 and 443; see <B>FirewallPorts</B>). This will |
|
| 153 |
+allow you to run Tor as a client behind a firewall with restrictive policies, |
|
| 154 |
+but will not allow you to run as a server behind such a firewall. |
|
| 155 |
+<DT><B>FirewallPorts </B><I>PORTS</I><DD> |
|
| 156 |
+A list of ports that your firewall allows you to connect to. Only used when |
|
| 157 |
+<B>FascistFirewall</B> is set. (Default: 80, 443.) |
|
| 158 |
+<DT><B><DD> |
|
| 159 |
+NewCircuitPeriod </B><I>NUM</I> |
|
| 160 |
+Every NUM seconds consider whether to build a new circuit. (Default: 60) |
|
| 161 |
+<DT><B>NodeFamily </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD> |
|
| 162 |
+The named Tor servers constitute a "family" of similar or co-administered |
|
| 163 |
+servers, so never use any two of them in the same circuit. Defining a |
|
| 164 |
+NodeFamily is only needed when a server doesn't list the family itself |
|
| 165 |
+(with MyFamily). This option can be used multiple times. |
|
| 166 |
+<DT> |
|
| 167 |
+<DD> |
|
| 168 |
+ |
|
| 169 |
+ |
|
| 170 |
+<B>RendNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I> |
|
| 171 |
+A list of preferred nodes to use for the rendezvous point, if possible. |
|
| 172 |
+<DT><B>RendExcludeNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD> |
|
| 173 |
+A list of nodes to never use when choosing a rendezvous point. |
|
| 174 |
+<DT><B>SOCKSPort </B><I>PORT</I><DD> |
|
| 175 |
+Bind to this port to listen for connections from SOCKS-speaking applications. |
|
| 176 |
+Set this to 0 if you don't want to allow application connections. (Default: |
|
| 177 |
+9050) |
|
| 178 |
+<DT><B>SOCKSBindAddress </B><I>IP</I><DD> |
|
| 179 |
+Bind to this address to listen for connections from socks-speaking applications. (Default: 127.0.0.1) You can also specify a port (e.g. 192.168.0.1:9100). This directive can be specified multiple times to bind to multiple addresses/ports. |
|
| 180 |
+<DT><B>SOCKSPolicy </B><I>policy</I>,<I>policy</I>,<I>...</I><DD> |
|
| 181 |
+Set an entrance policy for this server, to limit who can connect to the socks ports. The policies have the same form as exit policies below. |
|
| 182 |
+<P> |
|
| 183 |
+</DL> |
|
| 184 |
+<A NAME="lbAG"> </A> |
|
| 185 |
+<H2>SERVER OPTIONS</H2> |
|
| 186 |
+ |
|
| 187 |
+<P> |
|
| 188 |
+ |
|
| 189 |
+The following options are useful only for servers (that is, if <B>ORPort</B> is non-zero): |
|
| 190 |
+<DL COMPACT> |
|
| 191 |
+<DT><B>Address </B><I>address</I><DD> |
|
| 192 |
+The IP or fqdn of this server (e.g. moria.mit.edu). You can leave this |
|
| 193 |
+unset, and Tor will guess your IP. |
|
| 194 |
+<DT><B>ContactInfo </B><I>email_address</I><DD> |
|
| 195 |
+Administrative contact information for server. |
|
| 196 |
+<DT><B>ExitPolicy </B><I>policy</I>,<I>policy</I>,<I>...</I><DD> |
|
| 197 |
+Set an exit policy for this server. Each policy is of the form |
|
| 198 |
+"<B>accept</B>|<B>reject</B> <I>ADDR</I>[<B>/</B><I>MASK</I>]<B>:</B><I>PORT</I>". |
|
| 199 |
+If <B>/</B><I>MASK</I> is omitted then this policy just applies to the host |
|
| 200 |
+given. Instead of giving a host or network you can also use "<B>*</B>" to |
|
| 201 |
+denote the universe (0.0.0.0/0). <I>PORT</I> can be a single port number, |
|
| 202 |
+an interval of ports "<I>FROM_PORT</I><B>-</B><I>TO_PORT</I>", or "<B>*</B>". |
|
| 203 |
+<P> |
|
| 204 |
+For example, "reject 127.0.0.1:*,reject 192.168.1.0/24:*,accept *:*" would |
|
| 205 |
+reject any traffic destined for localhost and any 192.168.1.* address, but |
|
| 206 |
+accept anything else. |
|
| 207 |
+<P> |
|
| 208 |
+This directive can be specified multiple times so you don't have to put |
|
| 209 |
+it all on one line. |
|
| 210 |
+<P> |
|
| 211 |
+See RFC 3330 for more details about internal and reserved IP address |
|
| 212 |
+space. Policies are considered first to last, and the first match wins. If |
|
| 213 |
+you want to _replace_ the default exit policy, end your exit policy with |
|
| 214 |
+either a reject *:* or an accept *:*. Otherwise, you're _augmenting_ |
|
| 215 |
+(prepending to) the default exit policy. The default exit policy is: |
|
| 216 |
+ |
|
| 217 |
+<DL COMPACT><DT><DD> |
|
| 218 |
+<DL COMPACT> |
|
| 219 |
+<DT>reject 0.0.0.0/8<DD> |
|
| 220 |
+<DT>reject 169.254.0.0/16<DD> |
|
| 221 |
+<DT>reject 127.0.0.0/8<DD> |
|
| 222 |
+<DT>reject 192.168.0.0/16<DD> |
|
| 223 |
+<DT>reject 10.0.0.0/8<DD> |
|
| 224 |
+<DT>reject 172.16.0.0/12<DD> |
|
| 225 |
+<DT>accept *:20-22<DD> |
|
| 226 |
+<DT>accept *:53<DD> |
|
| 227 |
+<DT>accept *:79-81<DD> |
|
| 228 |
+<DT>accept *:110<DD> |
|
| 229 |
+<DT>accept *:143<DD> |
|
| 230 |
+<DT>accept *:443<DD> |
|
| 231 |
+<DT>accept *:706<DD> |
|
| 232 |
+<DT>accept *:873<DD> |
|
| 233 |
+<DT>accept *:993<DD> |
|
| 234 |
+<DT>accept *:995<DD> |
|
| 235 |
+<DT>reject *:4661-4662<DD> |
|
| 236 |
+<DT>reject *:1214<DD> |
|
| 237 |
+<DT>reject *:6346<DD> |
|
| 238 |
+<DT>accept *:1024-65535<DD> |
|
| 239 |
+<DT>reject *:*<DD> |
|
| 240 |
+</DL> |
|
| 241 |
+</DL> |
|
| 242 |
+ |
|
| 243 |
+ |
|
| 244 |
+<DT><B>MaxOnionsPending </B><I>NUM</I><DD> |
|
| 245 |
+If you have more than this number of onionskins queued for decrypt, reject new ones. (Default: 100) |
|
| 246 |
+<DT><B>MyFamily </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD> |
|
| 247 |
+Declare that this Tor server is controlled or administered by a group |
|
| 248 |
+or organization identical or similar to that of the other named servers. |
|
| 249 |
+When two servers both declare that they are in the same 'family', Tor clients |
|
| 250 |
+will not use them in the same circuit. (Each server only need to list the |
|
| 251 |
+other servers in its family; it doesn't need to list itself.) |
|
| 252 |
+<DT><B>Nickname </B><I>name</I><DD> |
|
| 253 |
+Set the server's nickname to 'name'. |
|
| 254 |
+<DT><B>NumCPUs </B><I>num</I><DD> |
|
| 255 |
+How many processes to use at once for decrypting onionskins. (Default: 1) |
|
| 256 |
+<DT><B>ORPort </B><I>PORT</I><DD> |
|
| 257 |
+Bind to this port to listen for connections from Tor clients and servers. |
|
| 258 |
+<DT><B>ORBindAddress </B><I>IP</I><DD> |
|
| 259 |
+Bind to this address to listen for connections from Tor clients and servers. (Default: 0.0.0.0) |
|
| 260 |
+<DT><B>RedirectExit </B><I>pattern target</I><DD> |
|
| 261 |
+Whenever an outgoing connection tries to connect to one of a given set |
|
| 262 |
+of addresses, connect to <I>target</I> (an <I>address:port</I> pair) instead. |
|
| 263 |
+The address |
|
| 264 |
+pattern is given in the same format as for an exit policy. The |
|
| 265 |
+address translation applies after exit policies are applied. Multiple |
|
| 266 |
+<B>RedirectExit</B> options can be used: once any one has matched |
|
| 267 |
+successfully, no subsequent rules are considered. You can specify that no |
|
| 268 |
+redirection is to be performed on a given set of addresses by using the |
|
| 269 |
+special target string "pass", which prevents subsequent rules from being |
|
| 270 |
+considered. |
|
| 271 |
+<DT><B>DirPostPeriod </B><I>N</I> <B>seconds</B>|<B>minutes</B>|<B>hours</B>|<B>days</B>|<B>weeks</B><DD> |
|
| 272 |
+Every time the specified period elapses, Tor uploads its server |
|
| 273 |
+descriptors to the directory servers. This information is also |
|
| 274 |
+uploaded whenever it changes. (Default: 20 minutes.) |
|
| 275 |
+<DT><B>AccountingMax </B><I>N</I> <B>bytes</B>|<B>KB</B>|<B>MB</B>|<B>GB</B>|<B>TB</B><DD> |
|
| 276 |
+Never send more than the specified number of bytes in a given |
|
| 277 |
+accounting period, or receive more than that number in the period. |
|
| 278 |
+When the number of bytes is exhausted, Tor will hibernate until some |
|
| 279 |
+time in the next accounting period. To prevent all servers from |
|
| 280 |
+waking at the same time, Tor will also wait until a random point in |
|
| 281 |
+each period before waking up. If you have bandwidth cost issues, |
|
| 282 |
+using this option is preferable to setting a low bandwidth, since it |
|
| 283 |
+provides users with a collection of fast servers that are up some of |
|
| 284 |
+the time, which is more useful than a set of slow servers that are |
|
| 285 |
+always "available". |
|
| 286 |
+<DT><B>AccountingStart </B><B>day</B>|<B>week</B>|<B>month</B> [<I>day</I>] <I>HH:MM</I><DD> |
|
| 287 |
+Specify how long accounting periods last. If <B>month</B> is given, |
|
| 288 |
+each accounting period runs from the time <I>HH:MM</I> on the |
|
| 289 |
+<I>day</I>th day of one month to the same day and time of the next. |
|
| 290 |
+(The day must be between 1 and 28.) If <B>week</B> is given, each |
|
| 291 |
+accounting period runs from the time <I>HH:MM</I> of the <I>day</I>th |
|
| 292 |
+day of one week to the same day and time of the next week, with Monday |
|
| 293 |
+as day 1 and Sunday as day 7. If <B>day</B> is given, each accounting |
|
| 294 |
+period runs from the time <I>HH:MM</I> each day to the same time on the |
|
| 295 |
+next day. All times are local, and given in 24-hour time. (Defaults to |
|
| 296 |
+"month 1 0:00".) |
|
| 297 |
+<P> |
|
| 298 |
+</DL> |
|
| 299 |
+<A NAME="lbAH"> </A> |
|
| 300 |
+<H2>DIRECTORY SERVER OPTIONS</H2> |
|
| 301 |
+ |
|
| 302 |
+<P> |
|
| 303 |
+ |
|
| 304 |
+The following options are useful only for directory servers (that is, if <B>DirPort</B> is non-zero): |
|
| 305 |
+<DL COMPACT> |
|
| 306 |
+<DT><B>AuthoritativeDirectory </B><B>0</B>|<B>1</B><DD> |
|
| 307 |
+When this option is set to 1, Tor operates as an authoritative |
|
| 308 |
+directory server. Instead of caching the directory, it generates its |
|
| 309 |
+own list of good servers, signs it, and sends that to the clients. |
|
| 310 |
+Unless the clients already have you listed as a trusted directory, you |
|
| 311 |
+probably do not want to set this option. Please coordinate with the other |
|
| 312 |
+admins at <A HREF="mailto:tor-ops@freehaven.net">tor-ops@freehaven.net</A> if you think you should be a directory. |
|
| 313 |
+<DT><B>DirPort </B><I>PORT</I><DD> |
|
| 314 |
+Bind the directory service to this port. |
|
| 315 |
+<DT><B>DirBindAddress </B><I>IP</I><DD> |
|
| 316 |
+Bind the directory service to this address. (Default: 0.0.0.0) |
|
| 317 |
+<DT><B>DirPolicy </B><I>policy</I>,<I>policy</I>,<I>...</I><DD> |
|
| 318 |
+Set an entrance policy for this server, to limit who can connect to the directory ports. The policies have the same form as exit policies above. |
|
| 319 |
+<DT><B>RecommendedVersions </B><I>STRING</I><DD> |
|
| 320 |
+STRING is a command-separated list of Tor versions currently believed |
|
| 321 |
+to be safe. The list is included in each directory, and nodes which |
|
| 322 |
+pull down the directory learn whether they need to upgrade. This |
|
| 323 |
+option can appear multiple times: the values from multiple lines are |
|
| 324 |
+spliced together. |
|
| 325 |
+<DT><B>RunTesting </B><B>0</B>|<B>1</B><DD> |
|
| 326 |
+If set to 1, Tor tries to build circuits through all of the servers it |
|
| 327 |
+knows about, so it can tell which are up and which are down. This |
|
| 328 |
+option is only useful for authoritative directories, so you probably |
|
| 329 |
+don't want to use it. |
|
| 330 |
+<P> |
|
| 331 |
+</DL> |
|
| 332 |
+<A NAME="lbAI"> </A> |
|
| 333 |
+<H2>HIDDEN SERVICE OPTIONS</H2> |
|
| 334 |
+ |
|
| 335 |
+<P> |
|
| 336 |
+ |
|
| 337 |
+The following options are used to configure a hidden service. |
|
| 338 |
+<DL COMPACT> |
|
| 339 |
+<DT><B>HiddenServiceDir </B><I>DIRECTORY</I><DD> |
|
| 340 |
+Store data files for a hidden service in DIRECTORY. Every hidden |
|
| 341 |
+service must have a separate directory. You may use this option multiple |
|
| 342 |
+times to specify multiple services. |
|
| 343 |
+<DT><B>HiddenServicePort </B><I>VIRTPORT </I>[<I>TARGET</I>]<DD> |
|
| 344 |
+Configure a virtual port VIRTPORT for a hidden service. You may use this |
|
| 345 |
+option multiple times; each time applies to the service using the most recent |
|
| 346 |
+hiddenservicedir. By default, this option maps the virtual port to the |
|
| 347 |
+same port on 127.0.0.1. You may override the target port, address, or both |
|
| 348 |
+by specifying a target of addr, port, or addr:port. |
|
| 349 |
+<DT><B>HiddenServiceNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD> |
|
| 350 |
+If possible, use the specified nodes as introduction points for the hidden |
|
| 351 |
+service. |
|
| 352 |
+<DT><B>HiddenServiceExcludeNodes </B><I>nickname</I>,<I>nickname</I>,<I>...</I><DD> |
|
| 353 |
+Do not use the specified nodes as introduction points for the hidden |
|
| 354 |
+service. |
|
| 355 |
+<P> |
|
| 356 |
+ |
|
| 357 |
+ |
|
| 358 |
+<P> |
|
| 359 |
+</DL> |
|
| 360 |
+<A NAME="lbAJ"> </A> |
|
| 361 |
+<H2>SIGNALS</H2> |
|
| 362 |
+ |
|
| 363 |
+Tor catches the following signals: |
|
| 364 |
+<DL COMPACT> |
|
| 365 |
+<DT><B>SIGTERM</B><DD> |
|
| 366 |
+Tor will catch this, clean up and sync to disk if necessary, and exit. |
|
| 367 |
+<DT><B>SIGINT</B><DD> |
|
| 368 |
+Tor clients behave as with SIGTERM; but Tor servers will do a controlled |
|
| 369 |
+slow shutdown, closing listeners and waiting 30 seconds before exiting. |
|
| 370 |
+<DT><B>SIGHUP</B><DD> |
|
| 371 |
+The signal instructs Tor to reload its configuration, fetch a new |
|
| 372 |
+directory, and kill and restart its helper processes if applicable. |
|
| 373 |
+<DT><B>SIGUSR1</B><DD> |
|
| 374 |
+Log statistics about current connections, past connections, and |
|
| 375 |
+throughput. |
|
| 376 |
+<DT><B>SIGUSR2</B><DD> |
|
| 377 |
+Switch all logs to loglevel debug. You can go back to the old loglevels |
|
| 378 |
+by sending a SIGHUP. |
|
| 379 |
+<DT><B>SIGCHLD</B><DD> |
|
| 380 |
+Tor receives this signal when one of its helper processes has exited, |
|
| 381 |
+so it can clean up. |
|
| 382 |
+<DT><B>SIGPIPE</B><DD> |
|
| 383 |
+Tor catches this signal and ignores it. |
|
| 384 |
+<DT><B>SIGXFSZ</B><DD> |
|
| 385 |
+If this signal exists on your platform, Tor catches and ignores it. |
|
| 386 |
+<P> |
|
| 387 |
+</DL> |
|
| 388 |
+<A NAME="lbAK"> </A> |
|
| 389 |
+<H2>FILES</H2> |
|
| 390 |
+ |
|
| 391 |
+<DL COMPACT> |
|
| 392 |
+<DT><I>/etc/tor/torrc</I> |
|
| 393 |
+ |
|
| 394 |
+<DD> |
|
| 395 |
+The configuration file, which contains "option value" pairs. |
|
| 396 |
+<DT><I>/etc/tor/dirservers</I> |
|
| 397 |
+ |
|
| 398 |
+<DD> |
|
| 399 |
+A list of directory servers, to bootstrap into the network. |
|
| 400 |
+<DT><I>/var/lib/tor/</I> |
|
| 401 |
+ |
|
| 402 |
+<DD> |
|
| 403 |
+The tor process stores keys and other data here. |
|
| 404 |
+<DT><I>/var/log/tor/</I> |
|
| 405 |
+ |
|
| 406 |
+<DD> |
|
| 407 |
+The tor server logs to this directory. |
|
| 408 |
+<DT><I>/var/run/tor/tor.pid</I> |
|
| 409 |
+ |
|
| 410 |
+<DD> |
|
| 411 |
+The PID of the tor (master) process is stored in this file. |
|
| 412 |
+<P> |
|
| 413 |
+</DL> |
|
| 414 |
+<A NAME="lbAL"> </A> |
|
| 415 |
+<H2>SEE ALSO</H2> |
|
| 416 |
+ |
|
| 417 |
+<B><A HREF="/cgi-bin/man/man2html?1+privoxy">privoxy</A></B>(1), |
|
| 418 |
+ |
|
| 419 |
+<B><A HREF="/cgi-bin/man/man2html?1+tsocks">tsocks</A></B>(1), |
|
| 420 |
+ |
|
| 421 |
+<B><A HREF="/cgi-bin/man/man2html?1+torify">torify</A></B>(1) |
|
| 422 |
+ |
|
| 423 |
+<P> |
|
| 424 |
+<B><A HREF="http://freehaven.net/tor/">http://freehaven.net/tor/</A></B> |
|
| 425 |
+ |
|
| 426 |
+<P> |
|
| 427 |
+<A NAME="lbAM"> </A> |
|
| 428 |
+<H2>BUGS</H2> |
|
| 429 |
+ |
|
| 430 |
+Plenty, probably. It's still in alpha. Please report them. |
|
| 431 |
+<A NAME="lbAN"> </A> |
|
| 432 |
+<H2>AUTHORS</H2> |
|
| 433 |
+ |
|
| 434 |
+Roger Dingledine <<A HREF="mailto:arma@mit.edu">arma@mit.edu</A>>, Nick Mathewson <<A HREF="mailto:nickm@alum.mit.edu">nickm@alum.mit.edu</A>>. |
|
| 435 |
+<P> |
|
| 436 |
+ |
|
| 437 |
+<HR> |
|
| 438 |
+<A NAME="index"> </A><H2>Index</H2> |
|
| 439 |
+<DL> |
|
| 440 |
+<DT><A HREF="#lbAB">NAME</A><DD> |
|
| 441 |
+<DT><A HREF="#lbAC">SYNOPSIS</A><DD> |
|
| 442 |
+<DT><A HREF="#lbAD">DESCRIPTION</A><DD> |
|
| 443 |
+<DT><A HREF="#lbAE">OPTIONS</A><DD> |
|
| 444 |
+<DT><A HREF="#lbAF">CLIENT OPTIONS</A><DD> |
|
| 445 |
+<DT><A HREF="#lbAG">SERVER OPTIONS</A><DD> |
|
| 446 |
+<DT><A HREF="#lbAH">DIRECTORY SERVER OPTIONS</A><DD> |
|
| 447 |
+<DT><A HREF="#lbAI">HIDDEN SERVICE OPTIONS</A><DD> |
|
| 448 |
+<DT><A HREF="#lbAJ">SIGNALS</A><DD> |
|
| 449 |
+<DT><A HREF="#lbAK">FILES</A><DD> |
|
| 450 |
+<DT><A HREF="#lbAL">SEE ALSO</A><DD> |
|
| 451 |
+<DT><A HREF="#lbAM">BUGS</A><DD> |
|
| 452 |
+<DT><A HREF="#lbAN">AUTHORS</A><DD> |
|
| 453 |
+</DL> |
|
| 454 |
+<HR> |
|
| 455 |
+This document was created by |
|
| 456 |
+<A HREF="/cgi-bin/man/man2html">man2html</A>, |
|
| 457 |
+using the manual pages.<BR> |
|
| 458 |
+Time: 21:47:46 GMT, February 15, 2005 |
|
| 459 |
+</BODY> |
|
| 460 |
+</HTML> |
|
| 0 | 461 |