clean up and slightly document the config files

svn:r179

8 files changed, 50 insertions, 24 deletions

diff --git a/src/config/dirservers b/src/config/dirservers
index 257e5b032..72392507c 100644
--- a/src/config/dirservers
+++ b/src/config/dirservers
@@ -1,7 +1,10 @@
 # List of directory servers.
 # Line format : address ORPort OPPort APPort DirPort bandwidth(bytes/s)
 # followed by the routers public key.
-# router-port is where the router is accepting connections from other routers.
+# ORport is where the router listens for other routers
+# OPPort is where the router listens for onion proxies (speaking cells)
+# APPort is where the router listens for applications (speaking socks)
+# DirPort is where the router listens for directory download requests
 
 # Router 1
 moria.mit.edu 9001 9011 9021 9031 1000000
diff --git a/src/config/moria1-orrc b/src/config/moria1-orrc
index f5a234486..246c1ae86 100644
--- a/src/config/moria1-orrc
+++ b/src/config/moria1-orrc
@@ -3,6 +3,7 @@
 # List of routers
 RouterFile ../config/routers.or
 
+# Be every role, including a directory server
 Role 63
 
 # Private key
@@ -18,6 +19,3 @@ DirPort 9031
 # Maximum number of connections.
 MaxConn 900
 
-# Which traffic shaping policy to use.
-# 
-TrafficShaping 1
diff --git a/src/config/moria2-orrc b/src/config/moria2-orrc
index 5970434a8..e18bc9596 100644
--- a/src/config/moria2-orrc
+++ b/src/config/moria2-orrc
@@ -3,6 +3,7 @@
 # List of routers
 RouterFile ../config/routers.or
 
+# Be every role, including a directory server
 Role 63
 
 # Private key
@@ -18,6 +19,3 @@ DirPort 9032
 # Maximum number of connections.
 MaxConn 900
 
-# Which traffic shaping policy to use.
-# 
-TrafficShaping 1
diff --git a/src/config/moria3-orrc b/src/config/moria3-orrc
index 0f37172f8..13364384d 100644
--- a/src/config/moria3-orrc
+++ b/src/config/moria3-orrc
@@ -3,6 +3,7 @@
 # List of routers
 RouterFile ../config/routers.or
 
+# Be every role, including a directory server
 Role 63
 
 # Private key
@@ -18,6 +19,3 @@ DirPort 9033
 # Maximum number of connections.
 MaxConn 900
 
-# Which traffic shaping policy to use.
-# 
-TrafficShaping 1
diff --git a/src/config/oprc b/src/config/oprc
index 2bf28e5a1..a1d617b1f 100644
--- a/src/config/oprc
+++ b/src/config/oprc
@@ -1,22 +1,27 @@
-# Configuration file for or
+# Configuration file for a typical or client
+# (listen for applications only)
 
-# List of routers
+# List of routers. Tor nodes only know about the directory servers
+# at the beginning, and from them they get a list of currently up nodes.
 RouterFile ../config/dirservers
 
-# Private key
-#PrivateKeyFile moria1-private
+# A file containing this node's private key, if applicable
+# (No need to specify one, since we're just a client)
+#PrivateKeyFile foo
 
+# Should paths tend to be very long (CoinWeight close to 1) or
+# quite short (CoinWeight close to 0)?
 CoinWeight 0.01
 
+# Ports for various services. Comment out if you're not running that
+# service.
 #ORPort 9001
 #OPPort 9011
 APPort 9050
 
-# Maximum number of connections.
+# Maximum number of sockets (of any sort) this node can have open
 MaxConn 900
 
+# Be a client: listen only for AP (socks) connections.
 Role 8
-# Which traffic shaping policy to use.
-# 
-#TrafficShaping 1
 
diff --git a/src/config/routers.or b/src/config/routers.or
index ec65416ae..5908ded0e 100644
--- a/src/config/routers.or
+++ b/src/config/routers.or
@@ -1,7 +1,10 @@
 # List of core onion routers in the network.
-# Line format : router-address router-port bandwidth(bytes/s) bandwidth(bytes/s)
+# Line format : address ORPort OPPort APPort DirPort bandwidth(bytes/s)
 # followed by the routers public key.
-# router-port is where the router is accepting connections from other routers.
+# ORport is where the router listens for other routers
+# OPPort is where the router listens for onion proxies (speaking cells)
+# APPort is where the router listens for applications (speaking socks)
+# DirPort is where the router listens for directory download requests
 
 # Router 1
 moria.mit.edu 9001 9011 9021 9031 1000000
diff --git a/src/config/sample-orrc b/src/config/sample-orrc
new file mode 100644
index 000000000..6c2ed6f65
--- /dev/null
+++ b/src/config/sample-orrc
@@ -0,0 +1,25 @@
+# Configuration file for a typical tor node
+
+# A file containing this node's private key
+PrivateKeyFile moria4-private
+
+# Ports for various services. Comment out or set to 0 if you're not
+# offering that service.
+ORPort 9004
+OPPort 9014
+APPort 9024
+#DirPort 0
+
+# *** NO NEED TO EDIT BELOW THIS LINE ***
+
+# List of routers. Tor nodes only know about the directory servers
+# at the beginning, and from them they get a list of currently up nodes.
+RouterFile ../config/dirservers
+
+# Should paths tend to be very long (CoinWeight close to 1) or
+# quite short (CoinWeight close to 0)?
+CoinWeight 0.1
+
+# Maximum number of sockets (of any sort) this node can have open
+MaxConn 900
+
diff --git a/src/config/ts4-orrc b/src/config/ts4-orrc
index c8d630323..47199de4e 100644
--- a/src/config/ts4-orrc
+++ b/src/config/ts4-orrc
@@ -15,7 +15,3 @@ APPort 9024
 # Maximum number of connections.
 MaxConn 900
 
-# Which traffic shaping policy to use.
-# 
-TrafficShaping 1
-