source: apps/routerconsole/jsp/help.jsp @ 2accbdc

Last change on this file since 2accbdc was 2accbdc, checked in by kytv <kytv@…>, 10 years ago

Operation close #354 part one of ??: Make the router console's help pages valid html. We *LOVE* valid HTML.

  • Property mode set to 100644
File size: 11.3 KB
1<%@page contentType="text/html"%>
2<%@page pageEncoding="UTF-8"%>
3<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
5  /*
6   *   Do not tag this file for translation - copy it to help_xx.jsp and translate inline.
7   */
9<html><head><title>I2P Router Console - help</title>
10<%@include file="css.jsi" %>
12<%@include file="summary.jsi" %>
13<h1>I2P Router Help &amp; Support</h1>
14<div class="main" id="main"><p>
15If you'd like to help improve or translate the documentation, or
16help with other aspects of the project, please see the documentation for
17<a href="http://www.i2p2.i2p/getinvolved.html">volunteers.</a>
18</p><p>Further assistance is available here:</p>
19<ul class="links">
20<li class="tidylist"><a href="http://www.i2p2.i2p/faq.html">FAQ on www.i2p2.i2p</a></li>
21<li class="tidylist"><a href="http://www.i2p2.i2p/faq_de.html">Deutsch FAQ</a>.</li></ul>
22<br>You may also try the <a href="http://forum.i2p/">I2P forum</a>
23or IRC.
25<h2>Summary Bar Information</h2><p>
26Many of the stats on the summary bar may be
27<a href="configstats.jsp">configured</a> to be
28<a href="graphs.jsp">graphed</a> for further analysis.
30<li class="tidylist"><b>Ident:</b>
31The first four characters (24 bits) of your 44-character (256-bit) Base64 router hash.
32The full hash is shown on your <a href="netdb.jsp?r=.">router info page</a>.
33Never reveal this to anyone, as your router info contains your IP.</li>
34<li class="tidylist"><b>Version:</b>
35The version of the I2P software you are running.</li>
36<li class="tidylist"><b>Now:</b>
37The current time (UTC) and the skew, if any. I2P requires your computer's time be accurate.
38If the skew is more than a few seconds, please correct the problem by adjusting
39your computer's time.</li>
40<li class="tidylist"><b>Reachability:</b>
41The router's view of whether it can be contacted by other routers.
42Further information is on the <a href="config.jsp#help">configuration page</a>.
44<li class="tidylist"><b>Active:</b>
45The first number is the number of peers you've sent or received a message from in the last few minutes.
46This may range from 8-10 to several hundred, depending on your total bandwidth,
47shared bandwidth, and locally-generated traffic.
48The second number is the number of peers seen in the last hour or so.
49Do not be concerned if these numbers vary widely.
50First enable all stats to <a href="configstats.jsp#router.activePeers">[Enable graphing]</a>.</li>
51<li class="tidylist"><b>Fast:</b>
52This is the number of peers you use for building client tunnels. It is generally in the
53range 8-30. Your fast peers are shown on the <a href="profiles.jsp">profiles page</a>.
54<a href="configstats.jsp#router.fastPeers">[Enable graphing]</a>.</li>
55<li class="tidylist"><b>High Capacity:</b>
56This is the number of peers you use for building some of your exploratory tunnels. It is generally in the
57range 8-75. The fast peers are included in the high capacity tier.
58Your high capacity peers are shown on the <a href="profiles.jsp">profiles page</a>.
59First enable all stats to <a href="configstats.jsp#router.highCapacityPeers">[Enable graphing]</a>.</li>
60<li class="tidylist"><b>Well Integrated:</b>
61This is the number of peers you use for network database inquiries.
62These are usually the "floodfill" peers.
63Your well integrated peers are shown on the bottom of the <a href="profiles.jsp">profiles page</a>.</li>
64<li class="tidylist"><b>Known:</b>
65This is the total number of routers you know about.
66They are listed on the <a href="netdb.jsp">network database page</a>.
67This may range from under 100 to 1000 or more.
68This number is not the total size of the network;
69it may vary widely depending on your total bandwidth,
70shared bandwidth, and locally-generated traffic.
71I2P does not require a router to know every other router.</li>
72</ul><h3>Bandwidth in/out</h3><div align="justify">
73Should be self-explanatory. All values are in bytes per second, not bits per second.
74Change your bandwidth limits on the <a href="config.jsp#help">configuration page</a>.
75Bandwidth is <a href="graphs.jsp">graphed</a> by default.</div>
77<h3>Local destinations</h3><div align="justify">
78The local applications connecting through your router.
79These may be clients started through <a href="i2ptunnel/index.jsp">I2PTunnel</a>
80or external programs connecting through SAM, BOB, or directly to I2CP.
81</div><h3>Tunnels in/out</h3><div align="justify">
82The actual tunnels are shown on the <a href="tunnels.jsp">the tunnels page</a>.</div><ul>
83<li class="tidylist"><div align="justify"><b>Exploratory:</b>
84Tunnels built by your router and used for communication with the floodfill peers,
85building new tunnels, and testing existing tunnels.</div></li>
86<li class="tidylist"><b>Client:</b>
87Tunnels built by your router for each client's use.</li>
88<li class="tidylist"><b>Participating:</b>
89Tunnels built by other routers through your router.
90This may vary widely depending on network demand, your
91shared bandwidth, and amount of locally-generated traffic.
92The recommended method for limiting participating tunnels is
93to change your share percentage on the <a href="config.jsp#help">configuration page</a>.
94You may also limit the total number by setting <tt>router.maxParticipatingTunnels=nnn</tt> on
95the <a href="configadvanced.jsp">advanced configuration page</a>. <a href="configstats.jsp#tunnel.participatingTunnels">[Enable graphing]</a>.</li>
96<li class="tidylist"><b>Share ratio:</b>
97The number of participating tunnels you route for others, divided by the total number of hops in
98all your exploratory and client tunnels.
99A number greater than 1.00 means you are contributing more tunnels to the network than you are using.</li>
102<h3>Congestion</h3><div align="justify">
103Some basic indications of router overload:</div><ul>
104<li class="tidylist"><b>Job lag:</b>
105How long jobs are waiting before execution. The job queue is listed on the <a href="jobs.jsp">jobs page</a>.
106Unfortunately, there are several other job queues in the router that may be congested,
107and their status is not available in the router console.
108The job lag should generally be zero.
109If it is consistently higher than 500ms, your computer is very slow, or the
110router has serious problems.
111<a href="configstats.jsp#jobQueue.jobLag">[Enable graphing]</a>.</li>
112<li class="tidylist"><b>Message delay:</b>
113How long an outbound message waits in the queue.
114This should generally be a few hundred milliseconds or less.
115If it is consistently higher than 1000ms, your computer is very slow,
116or you should adjust your bandwidth limits, or your (bittorrent?) clients
117may be sending too much data and should have their transmit bandwidth limit reduced.
118<a href="configstats.jsp#transport.sendProcessingTime">[Enable graphing]</a> (transport.sendProcessingTime).</li>
119<li class="tidylist"><b>Tunnel lag:</b>
120This is the round trip time for a tunnel test, which sends a single message
121out a client tunnel and in an exploratory tunnel, or vice versa.
122It should usually be less than 5 seconds.
123If it is consistently higher than that, your computer is very slow,
124or you should adjust your bandwidth limits, or there are network problems.
125<a href="configstats.jsp#tunnel.testSuccessTime">[Enable graphing]</a> (tunnel.testSuccessTime).</li>
126<li class="tidylist"><b>Handle backlog:</b>
127This is the number of pending requests from other routers to build a
128participating tunnel through your router.
129It should usually be close to zero.
130If it is consistently high, your computer is too slow,
131and you should reduce your share bandwidth limits.</li>
132<li class="tidylist"><b>Accepting/Rejecting:</b>
133Your router's status on accepting or rejecting
134requests from other routers to build a
135participating tunnel through your router.
136Your router may accept all requests, accept or reject a percentage of requests,
137or reject all requests for a number of reasons, to control
138the bandwidth and CPU demands and maintain capacity for
139local clients.</li></ul>
141<h2>Legal stuff</h2><p>The I2P router (router.jar) and SDK (i2p.jar) are almost entirely public domain, with
142a few notable exceptions:</p><ul>
143<li class="tidylist">ElGamal and DSA code, under the BSD license, written by TheCrypto</li>
144<li class="tidylist">SHA256 and HMAC-SHA256, under the MIT license, written by the Legion of the Bouncycastle</li>
145<li class="tidylist">AES code, under the Cryptix (MIT) license, written by the Cryptix team</li>
146<li class="tidylist">SNTP code, under the BSD license, written by Adam Buckley</li>
147<li class="tidylist">The rest is outright public domain, written by jrandom, mihi, hypercubus, oOo,
148    ugha, duck, shendaras, and others.</li>
151<p>On top of the I2P router are a series of client applications, each with their own set of
152licenses and dependencies.  This webpage is being served as part of the I2P routerconsole
153client application, which is built off a trimmed down <a href="">Jetty</a>
154instance (trimmed down, as in, we do not include the demo apps or other add-ons, and we simplify configuration),
155allowing you to deploy standard JSP/Servlet web applications into your router.  Jetty in turn makes use of
156Apache's javax.servlet (javax.servlet.jar) implementation.
157This product includes software developed by the Apache Software Foundation
160<p>Another application you can see on this webpage is <a href="http://www.i2p2.i2p/i2ptunnel">I2PTunnel</a>
161(your <a href="i2ptunnel/" target="_blank">web interface</a>) - a GPL'ed application written by mihi that
162lets you tunnel normal TCP/IP traffic over I2P (such as the eepproxy and the irc proxy).  There is also a
163<a href="http://susi.i2p/">susimail</a> web based mail client <a href="susimail/susimail">available</a> on
164the console, which is a GPL'ed application written by susi23.  The addressbook application, written by
165<a href="http://ragnarok.i2p/">Ragnarok</a> helps maintain your hosts.txt files (see ./addressbook/ for
166more information).</p>
168<p>The router by default also includes human's public domain <a href="http://www.i2p2.i2p/sam">SAM</a> bridge,
169which other client applications (such the <a href="http://duck.i2p/i2p-bt/">bittorrent port</a>) can use.
170There is also an optimized library for doing large number calculations - jbigi - which in turn uses the
171LGPL licensed <a href="">GMP</a> library, tuned for various PC architectures.  Launchers for windows users
172are built with <a href="">Launch4J</a>, and the installer is built with
173<a href="">IzPack</a>.  For
174details on other applications available, as well as their licenses, please see the
175<a href="http://www.i2p2.i2p/licenses">license policy</a>.  Source for the I2P code and most bundled
176client applications can be found on our <a href="http://www.i2p2.i2p/download">download page</a>.
179<h2>Change Log</h2>
180 <jsp:useBean class="net.i2p.router.web.ContentHelper" id="contenthelper" scope="request" />
181 <% fpath = new, "history.txt"); %>
182 <jsp:setProperty name="contenthelper" property="page" value="<%=fpath.getAbsolutePath()%>" />
183 <jsp:setProperty name="contenthelper" property="maxLines" value="256" />
184 <jsp:setProperty name="contenthelper" property="startAtBeginning" value="true" />
185 <jsp:getProperty name="contenthelper" property="textContent" />
187 <p><a href="/history.txt">View the full change log</a>
188 </p><hr></div></body></html>
Note: See TracBrowser for help on using the repository browser.