source: installer/java/src/router.config.template @ 03562b0

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

added (commented out) hooks for the 0.4 web arch

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