Merge branch 'master' of ssh://gnunet.org/gnunet
[oweals/gnunet.git] / src / transport / transport.conf.in
index 20a878c2e4559d6b839cfbe63a248cf2ff21ebca..2c99af000d6ca782115e623679b5e5ab2420f83b 100644 (file)
@@ -4,6 +4,8 @@ AUTOSTART = @AUTOSTART@
 HOSTNAME = localhost
 BINARY = gnunet-service-transport
 # PREFIX = valgrind
+
+# Maximum number of neighbours PER PLUGIN (not in total).
 NEIGHBOUR_LIMIT = 50
 ACCEPT_FROM = 127.0.0.1;
 ACCEPT_FROM6 = ::1;
@@ -38,7 +40,17 @@ TESTING_IGNORE_KEYS = ACCEPT_FROM;
 [transport-tcp]
 # Use 0 to ONLY advertise as a peer behind NAT (no port binding)
 PORT = 2086
+
+# Obsolete option, to be replaced by HOLE_EXTERNAL (soon)
 ADVERTISED_PORT = 2086
+
+# If we have a manually punched NAT, what is the external IP and port?
+# Can use DNS names for DynDNS-based detection of external IP.
+# Can use IPv6 addresses ([fefc::]:PORT).
+# Use "AUTO" for the hostname to automatically detect external IP.
+# Do not set if NAT is not manually punched.
+# HOLE_EXTERNAL = AUTO:2086
+
 TESTING_IGNORE_KEYS = ACCEPT_FROM;
 
 # Maximum number of open TCP connections allowed
@@ -52,15 +64,32 @@ TIMEOUT = 5 s
 # BINDTO =
 MAX_CONNECTIONS = 128
 
+# Enable TCP stealth?
+TCP_STEALTH = NO
+
+
 [transport-udp]
 # Use PORT = 0 to autodetect a port available
 PORT = 2086
 BROADCAST = YES
 BROADCAST_RECEIVE = YES
 BROADCAST_INTERVAL = 30 s
+
+# This limits UDP to 1MB/s for SENDING. Higher values are advised
+# for benchmarking or well-connected systems.  Note that this quota
+# applies IN ADDITION to the system-wide transport-wide WAN/LAN
+# quotas.
 MAX_BPS = 1000000
 TESTING_IGNORE_KEYS = ACCEPT_FROM;
 
+# If we have a manually punched NAT, what is the external IP and port?
+# Can use DNS names for DynDNS-based detection of external IP.
+# Can use IPv6 addresses ([fefc::]:PORT).
+# Use "AUTO" for the hostname to automatically detect external IP.
+# Do not set if NAT is not manually punched.
+# HOLE_EXTERNAL = AUTO:2086
+
+
 [transport-http_client]
 MAX_CONNECTIONS = 128
 TESTING_IGNORE_KEYS = ACCEPT_FROM;
@@ -68,11 +97,11 @@ TESTING_IGNORE_KEYS = ACCEPT_FROM;
 # PROXY =
 
 # User name for proxy server
-# PROXY_USERNAME = 
+# PROXY_USERNAME =
 # User password for proxy server
-# PROXY_PASSWORD = 
+# PROXY_PASSWORD =
 
-# Type of proxy server, 
+# Type of proxy server,
 # Valid values: HTTP, SOCKS4, SOCKS5, SOCKS4A, SOCKS5_HOSTNAME
 # Default: HTTP
 # PROXY_TYPE = HTTP
@@ -81,13 +110,28 @@ TESTING_IGNORE_KEYS = ACCEPT_FROM;
 # Experimental, default: NO
 # PROXY_HTTP_TUNNELING = NO
 
+
 [transport-http_server]
 #EXTERNAL_HOSTNAME = <your hostname/path>
 PORT = 1080
+
+# Obsolete option, to be replaced by HOLE_EXTERNAL (soon)
 ADVERTISED_PORT = 1080
+
+# If we have a manually punched NAT, what is the external IP and port?
+# Can use DNS names for DynDNS-based detection of external IP.
+# Can use IPv6 addresses ([fefc::]:PORT).
+# Use "AUTO" for the hostname to automatically detect external IP.
+# Do not set if NAT is not manually punched.
+# HOLE_EXTERNAL = AUTO:1080
+
 MAX_CONNECTIONS = 128
 TESTING_IGNORE_KEYS = ACCEPT_FROM;
 
+# Enable TCP stealth?
+TCP_STEALTH = NO
+
+
 [transport-https_client]
 MAX_CONNECTIONS = 128
 TESTING_IGNORE_KEYS = ACCEPT_FROM;
@@ -95,11 +139,11 @@ TESTING_IGNORE_KEYS = ACCEPT_FROM;
 # PROXY =
 
 # User name for proxy server
-# PROXY_USERNAME = 
+# PROXY_USERNAME =
 # User password for proxy server
-# PROXY_PASSWORD = 
+# PROXY_PASSWORD =
 
-# Type of proxy server, 
+# Type of proxy server,
 # Valid values: HTTP, SOCKS4, SOCKS5, SOCKS4A, SOCKS5_HOSTNAME
 # Default: HTTP
 # PROXY_TYPE = HTTP
@@ -109,7 +153,6 @@ TESTING_IGNORE_KEYS = ACCEPT_FROM;
 # PROXY_HTTP_TUNNELING = NO
 
 
-
 [transport-https_server]
 # EXTERNAL_HOSTNAME = <your hostname/path>
 # EXTERNAL_HOSTNAME_ONLY = YES
@@ -119,13 +162,27 @@ TESTING_IGNORE_KEYS = ACCEPT_FROM;
 # Does the external hostname use the same port?
 # EXTERNAL_HOSTNAME_USE_PORT = YES
 PORT = 4433
+
+# Obsolete option, to be replaced by HOLE_EXTERNAL (soon)
 ADVERTISED_PORT = 4433
+
+# If we have a manually punched NAT, what is the external IP and port?
+# Can use DNS names for DynDNS-based detection of external IP.
+# Can use IPv6 addresses ([fefc::]:PORT).
+# Use "AUTO" for the hostname to automatically detect external IP.
+# Do not set if NAT is not manually punched.
+# HOLE_EXTERNAL = AUTO:4433
+
 CRYPTO_INIT = NORMAL
 KEY_FILE = $GNUNET_DATA_HOME/transport/https.key
 CERT_FILE = $GNUNET_DATA_HOME/transport/https.cert
 MAX_CONNECTIONS = 128
 TESTING_IGNORE_KEYS = ACCEPT_FROM;
 
+# Enable TCP stealth?
+TCP_STEALTH = NO
+
+
 [transport-wlan]
 # Name of the interface in monitor mode (typically monX)
 INTERFACE = mon0
@@ -133,6 +190,7 @@ INTERFACE = mon0
 TESTMODE = 0
 TESTING_IGNORE_KEYS = ACCEPT_FROM;
 
+
 [transport-bluetooth]
 # Name of the interface (typically hciX)
 INTERFACE = hci0