source: installer/java/src/router.config.template @ 9ecfda0

Last change on this file since 9ecfda0 was 9ecfda0, checked in by zzz <zzz@…>, 17 years ago

added basic HTTP authentication for accessing the router console (if a consolePassword is specified in the router.config)
unfortunately, this password setting is only read on router startup…

  • Property mode set to 100644
File size: 9.0 KB
Line 
1# I2P router configuration
2# Created on ##NOW##
3
4# TCP configuration, for inbound TCP/IP connections
5##_router_hn##
6##_router_port##
7##_router_lavalid##
8
9# maximum number of TCP connections we will want to
10# attempt to establish at once (each of which
11# requires a 2048bit DH exchange)
12i2np.tcp.concurrentEstablishers=5
13
14# I2CP client port, for client connections
15i2cp.port=##_router_i2cp_port##
16
17# I2P router administrative web port (currently only responds to /routerConsole.html)
18router.adminPort=7655
19
20# Bandwidth limits
21# These limits are for all i2np connections - tcp or whatever to all peers.
22# They are hard enforced with no smoothing.  If they are <= 0, no limits are enforced.
23# Do not set this lower than 6KBps
24i2np.bandwidth.inboundKBytesPerSecond=-1
25i2np.bandwidth.outboundKBytesPerSecond=-1
26# How many bytes will we let accumulate due to inactivity (allowing bursts)?
27# Do not set this lower than the rate above - doing so will not achieve what you want, really.
28# (the bandwidth limiter uses a token bucket algorithm and this burst defines the size of the
29# bucket)
30i2np.bandwidth.inboundBurstKBytes=-1
31i2np.bandwidth.outboundBurstKBytes=-1
32
33# Publish peer rankings
34# If true, include the current liveliness and reliability rankings in one's published RouterInfo data
35# Setting this to true will help debug the network and is especially useful while we'return still testing
36# However, traffic analysis may be easier with this data published (though there's no reason to think people
37# can't just fake the info in this).
38# Since we're still very much < 1.0, this will be true for the current release by default.  As we get some
39# network helth information and tune the ranking algorithms, this will become false by default. 
40# You, of course, can change this to either true or false whenever you'd like.  This is only read
41# on router startup though, so you need to restart the router if you change it.
42router.publishPeerRankings=true
43
44# Keep message history
45# This series of options can help out in debugging the network by keeping a
46# seperate log of all messages sent over the network (but without any personally identifiable information)
47# This is entirely optional, but would be greatly appreciated during the
48# development phase of the network since it would allow the developers to detect
49# errors much more easily
50router.keepHistory=false
51
52# Submit message history
53# This option works only if router.keepHistory is true and periodically sends
54# in the router history logs to the developers (specifically, it submits the file
55# via HTTP POST to http://i2p.net/cgi-bin/submitMessageHistory - you can see a sample of what
56# one of those files looks like at http://i2p.net/~jrandom/sampleHist.txt)
57# After submitting this file, it deletes the local copy (otherwise the file will grow
58# without bound - tens of MB per day)
59# Again, this is entirely optional, but would be greatly appreciated as it should help
60# out the development process
61router.submitHistory=false
62
63# Target clients
64# How many concurrent clients the router should prepare for
65# This, factored in with the tunnel settings, determines the size of the pools -
66# too many, and your machine consumes excessive CPU and bandwidth, too few and your
67# clients take too long to startup. 
68# e.g. If you are running an eepsite, an eepProxy, an irc proxy, and a squid proxy, set this to 4
69router.targetClients=2
70
71# Number of inbound tunnels per client
72# This determines how many inbound tunnels will be allocated per client at a time.
73# This is a key factor in the reliability of a client receiving messages
74# As above, too many and your machine gets hosed, too few and the pool is slow. 
75# 2 should be sufficient - prior to 0.2.5, we have all had only 1
76tunnels.numInbound=2
77
78# Number of outbound tunnels per client
79# This determines how many outbound tunnels must exist when a client is in operation.
80# XXX Not currently enforced - ignore this setting
81tunnels.numOutbound=2
82
83# Depth of inbound tunnels
84# This determines the length of inbound tunnels created - how many remote routers to
85# include (0 means no remote routers, 3 means a total of four routers, including
86# the local one, etc).  This is a key factor in the reliability and anonymity
87# provided by I2P
88# Users should simply leave this as 2 for now
89tunnels.depthInbound=2
90
91# Depth of outbound tunnels
92# This determines the length of outbound tunnels created - how many remote routers to
93# include (0 means no remote routers, 3 means a total of four routers, including
94# the local one, etc).  This is a key factor in the reliability and anonymity
95# provided by I2P
96# Users should simply leave this as 2 for now, at least until the tunnels are more reliable (post 0.3)
97tunnels.depthOutbound=2
98
99# Tunnel duration
100# This determines how long tunnels we create should last for (in milliseconds).  Too
101# long and they are more prone to failure, too short and people need to do more network
102# database lookups.  The default of 10 minutes (600000 ms) should be used
103# You should not change this setting unless you really know what you're doing
104tunnels.tunnelDuration=600000
105
106# shutdown password
107# uncomment the following (after changing the value) to allow shutting down the
108# router through the web interface (using the form provided, or directly via
109# http://localhost:7655/shutdown?password=thisIsASecret)
110#router.shutdownPassword=thisIsASecret
111
112#
113# the remaining lines describe how you can get your router to fire up client
114# applications it is up and running, all within the router's JVM.  Uncomment the
115# ones you want (revising the numbers and ports accordingly)
116
117# Keep the router's clock in sync by querying one of the specified NTP servers once
118# a minute (uses UDP port 123)
119# This defaults to the DNS round-robin ntp pool - see http://www.pool.ntp.org/
120# Please change the NTP server specified to include ones closer to you - see
121# http://www.eecis.udel.edu/~mills/ntp/clock2a.html for a list (you can specify as
122# many as you want on the args= line - they'll be tried in order until one answers).
123# Some example servers you may want to try:
124#  US: dewey.lib.ci.phoenix.az.us
125#  US: clock.fmt.he.net
126#  BR: ntp1.pucpr.br
127#  BE: ntp2.belbone.be
128#  AU: ntp.saard.net
129clientApp.0.main=net.i2p.time.Timestamper
130clientApp.0.name=Timestamper
131clientApp.0.onBoot=true
132clientApp.0.args=http://localhost:7655/setTime?##timestamperPassword## pool.ntp.org pool.ntp.org pool.ntp.org
133
134# The admin time passphrase, used to prevent unauthorized people from updating your
135# routers time.  The value should be included in the timestamper's args above,
136# otherwise it wont honor timestamp updates.  You shouldnt include any spaces or funky
137# characters - just pick some random numbers.
138adminTimePassphrase=##timestamperPassword##
139
140# SAM bridge (a simplified socket based protocol for using I2P - listens on port 7656.  see
141# the specs at http://www.i2p.net/node/view/144 for more info)
142clientApp.1.main=net.i2p.sam.SAMBridge
143clientApp.1.name=SAMBridge
144clientApp.1.args=sam.keys 0.0.0.0 7656 i2cp.tcp.host=localhost i2cp.tcp.port=##_router_i2cp_port##
145
146# The eepProxy (HTTP proxy that lets you browse both eepsites and the normal web via squid.i2p) and
147# the ircProxy (which connects to the anonymously hosted ircd at irc.duck.i2p)
148clientApp.2.main=net.i2p.i2ptunnel.I2PTunnel
149clientApp.2.name=Tunnels
150clientApp.2.args=-nocli -e "config localhost ##_router_i2cp_port##" -e "httpclient 4444" -e "client 6668 irc.duck.i2p"
151# note: if you want the proxies to be reachable from other machines, add:
152#       -e "listen_on 0.0.0.0"   
153# before the -e "httpclient 4444".  otherwise, both of these proxies will only listen for connections on 127.0.0.1
154
155# New router console webapp, driven by Jetty
156# to use, you must mkdir ./webapps/ and place the routerconsole.war file in there,
157# and add jetty-all.jar and routerconsole.jar in the router's classpath in the startRouter
158# script
159# (don't bother trying to figure this out prior to the 0.4 release)
160#clientApp.3.main=net.i2p.router.web.RouterConsoleRunner
161#clientApp.3.name=webConsole
162#clientApp.3.args=7657 127.0.0.1 ./webapps/
163#clientApp.3.onBoot=true
164
165# To require simple HTTP authentication for accessing any of the pages underneath the web console
166# (including any other webapps deployed), uncomment the following line and set the password
167# accordingly (the username is 'admin').  If the following is commented out, or is blank, then
168# no password will be required, and anyone will be able to access your router console (and change
169# settings, etc).  This is only used for the new jetty console (started in clientApp.3.* above)
170#
171#consolePassword=fooBarBaz
172
173# Network monitor (harvests data from the network database and stores it under
174# monitorData/, and with the netviewer GUI you can browse through its results)
175#clientApp.4.main=net.i2p.netmonitor.NetMonitor
176#clientApp.4.name=NetMonitor
177#clientApp.4.args=
178
179# Heartbeat engine (ueber-simple ping/pong system, configured in heartbeat.config.  By itself
180# it just writes out stat data where its told to, but there's a seperate HeartbeatMonitor
181# GUI to let you visualize things)
182#clientApp.5.main=net.i2p.heartbeat.Heartbeat
183#clientApp.5.name=Heartbeat
184#clientApp.5.args=heartbeat.config
Note: See TracBrowser for help on using the repository browser.