From 2ae293444e82be8e4dea9610875428bc036b70b9 Mon Sep 17 00:00:00 2001 From: str4d Date: Thu, 31 Oct 2013 21:22:24 +0000 Subject: [PATCH] Split routerconsole help into several files (no frontend change) The old full-page translations of help.jsp are deprecated. The help text will be tagged for translation on Transifex. --- apps/routerconsole/jsp/help.jsp | 167 +----------------- apps/routerconsole/jsp/help/help.jsi | 9 + apps/routerconsole/jsp/help/legal.jsi | 38 ++++ .../{ => help/old-translations}/help_ar.jsp | 0 .../{ => help/old-translations}/help_fr.jsp | 0 .../{ => help/old-translations}/help_nl.jsp | 0 .../{ => help/old-translations}/help_ru.jsp | 0 apps/routerconsole/jsp/help/sidebar.jsi | 117 ++++++++++++ 8 files changed, 167 insertions(+), 164 deletions(-) create mode 100644 apps/routerconsole/jsp/help/help.jsi create mode 100644 apps/routerconsole/jsp/help/legal.jsi rename apps/routerconsole/jsp/{ => help/old-translations}/help_ar.jsp (100%) rename apps/routerconsole/jsp/{ => help/old-translations}/help_fr.jsp (100%) rename apps/routerconsole/jsp/{ => help/old-translations}/help_nl.jsp (100%) rename apps/routerconsole/jsp/{ => help/old-translations}/help_ru.jsp (100%) create mode 100644 apps/routerconsole/jsp/help/sidebar.jsi diff --git a/apps/routerconsole/jsp/help.jsp b/apps/routerconsole/jsp/help.jsp index 29dbc5ce6..730ad8697 100644 --- a/apps/routerconsole/jsp/help.jsp +++ b/apps/routerconsole/jsp/help.jsp @@ -15,171 +15,10 @@ <%@include file="summary.jsi" %>

I2P Router Help & Support

-If you'd like to help improve or translate the documentation, or -help with other aspects of the project, please see the documentation for -volunteers. -

Further assistance is available here:

- -
You may also try the I2P forum -or IRC. -

Summary Bar Information

-Many of the stats on the summary bar may be -configured to be -graphed for further analysis. -

General

Peers

Bandwidth in/out

-Should be self-explanatory. All values are in bytes per second, not bits per second. -Change your bandwidth limits on the configuration page. -Bandwidth is graphed by default.
- -

Local destinations

-The local applications connecting through your router. -These may be clients started through I2PTunnel -or external programs connecting through SAM, BOB, or directly to I2CP. -

Tunnels in/out

-The actual tunnels are shown on the the tunnels page.
- -

Congestion

-Some basic indications of router overload:
- -

Legal stuff

The I2P router (router.jar) and SDK (i2p.jar) are almost entirely public domain, with -a few notable exceptions:

- -

On top of the I2P router are a series of client applications, each with their own set of -licenses and dependencies. This webpage is being served as part of the I2P routerconsole -client application, which is built off a trimmed down Jetty -instance (trimmed down, as in, we do not include the demo apps or other add-ons, and we simplify configuration), -allowing you to deploy standard JSP/Servlet web applications into your router. Jetty in turn makes use of -Apache's javax.servlet (javax.servlet.jar) implementation. -This product includes software developed by the Apache Software Foundation -(http://www.apache.org/).

- -

Another application you can see on this webpage is I2PTunnel -(your web interface) - a GPL'ed application written by mihi that -lets you tunnel normal TCP/IP traffic over I2P (such as the eepproxy and the irc proxy). There is also a -susimail web based mail client available on -the console, which is a GPL'ed application written by susi23. The addressbook application, written by -Ragnarok helps maintain your hosts.txt files (see ./addressbook/ for -more information).

- -

The router by default also includes human's public domain SAM bridge, -which other client applications (such the bittorrent port) can use. -There is also an optimized library for doing large number calculations - jbigi - which in turn uses the -LGPL licensed GMP library, tuned for various PC architectures. Launchers for windows users -are built with Launch4J, and the installer is built with -IzPack. For -details on other applications available, as well as their licenses, please see the -license policy. Source for the I2P code and most bundled -client applications can be found on our download page. -.

+<%@include file="help/help.jsi" %> +<%@include file="help/legal.jsi" %> +<%@include file="help/sidebar.jsi" %>

Change Log

diff --git a/apps/routerconsole/jsp/help/help.jsi b/apps/routerconsole/jsp/help/help.jsi new file mode 100644 index 000000000..d1fbccf8b --- /dev/null +++ b/apps/routerconsole/jsp/help/help.jsi @@ -0,0 +1,9 @@ +If you'd like to help improve or translate the documentation, or +help with other aspects of the project, please see the documentation for +volunteers. +

Further assistance is available here:

+ +
You may also try the I2P forum +or IRC. diff --git a/apps/routerconsole/jsp/help/legal.jsi b/apps/routerconsole/jsp/help/legal.jsi new file mode 100644 index 000000000..45c160cf8 --- /dev/null +++ b/apps/routerconsole/jsp/help/legal.jsi @@ -0,0 +1,38 @@ +

Legal stuff

+

The I2P router (router.jar) and SDK (i2p.jar) are almost entirely public domain, with +a few notable exceptions:

+
    +
  • ElGamal and DSA code, under the BSD license, written by TheCrypto
    • +
  • SHA256 and HMAC-SHA256, under the MIT license, written by the Legion of the Bouncycastle
    • +
  • AES code, under the Cryptix (MIT) license, written by the Cryptix team
    • +
  • SNTP code, under the BSD license, written by Adam Buckley
    • +
  • The rest is outright public domain, written by jrandom, mihi, hypercubus, oOo, + ugha, duck, shendaras, and others.
    • +
+ +

On top of the I2P router are a series of client applications, each with their own set of +licenses and dependencies. This webpage is being served as part of the I2P routerconsole +client application, which is built off a trimmed down Jetty +instance (trimmed down, as in, we do not include the demo apps or other add-ons, and we simplify configuration), +allowing you to deploy standard JSP/Servlet web applications into your router. Jetty in turn makes use of +Apache's javax.servlet (javax.servlet.jar) implementation. +This product includes software developed by the Apache Software Foundation +(http://www.apache.org/).

+ +

Another application you can see on this webpage is I2PTunnel +(your web interface) - a GPL'ed application written by mihi that +lets you tunnel normal TCP/IP traffic over I2P (such as the eepproxy and the irc proxy). There is also a +susimail web based mail client available on +the console, which is a GPL'ed application written by susi23. The addressbook application, written by +Ragnarok helps maintain your hosts.txt files (see ./addressbook/ for +more information).

+ +

The router by default also includes human's public domain SAM bridge, +which other client applications (such the bittorrent port) can use. +There is also an optimized library for doing large number calculations - jbigi - which in turn uses the +LGPL licensed GMP library, tuned for various PC architectures. Launchers for windows users +are built with Launch4J, and the installer is built with +IzPack. For +details on other applications available, as well as their licenses, please see the +license policy. Source for the I2P code and most bundled +client applications can be found on our download page.

diff --git a/apps/routerconsole/jsp/help_ar.jsp b/apps/routerconsole/jsp/help/old-translations/help_ar.jsp similarity index 100% rename from apps/routerconsole/jsp/help_ar.jsp rename to apps/routerconsole/jsp/help/old-translations/help_ar.jsp diff --git a/apps/routerconsole/jsp/help_fr.jsp b/apps/routerconsole/jsp/help/old-translations/help_fr.jsp similarity index 100% rename from apps/routerconsole/jsp/help_fr.jsp rename to apps/routerconsole/jsp/help/old-translations/help_fr.jsp diff --git a/apps/routerconsole/jsp/help_nl.jsp b/apps/routerconsole/jsp/help/old-translations/help_nl.jsp similarity index 100% rename from apps/routerconsole/jsp/help_nl.jsp rename to apps/routerconsole/jsp/help/old-translations/help_nl.jsp diff --git a/apps/routerconsole/jsp/help_ru.jsp b/apps/routerconsole/jsp/help/old-translations/help_ru.jsp similarity index 100% rename from apps/routerconsole/jsp/help_ru.jsp rename to apps/routerconsole/jsp/help/old-translations/help_ru.jsp diff --git a/apps/routerconsole/jsp/help/sidebar.jsi b/apps/routerconsole/jsp/help/sidebar.jsi new file mode 100644 index 000000000..2cd4a4185 --- /dev/null +++ b/apps/routerconsole/jsp/help/sidebar.jsi @@ -0,0 +1,117 @@ +

Summary Bar Information

+Many of the stats on the summary bar may be +configured to be +graphed for further analysis. +

General

    +
  • Local Identity: +The first four characters (24 bits) of your 44-character (256-bit) Base64 router hash. +The full hash is shown on your router info page. +Never reveal this to anyone, as your router info contains your IP.
    • +
  • Version: +The version of the I2P software you are running.
    • +<% +/*
  • Now: +The current time (UTC) and the skew, if any. I2P requires your computer's time be accurate. +If the skew is more than a few seconds, please correct the problem by adjusting +your computer's time.
    • */ +%> +
  • Reachability: +The router's view of whether it can be contacted by other routers. +Further information is on the configuration page. +

Peers

    +
  • Active: +The first number is the number of peers you've sent or received a message from in the last few minutes. +This may range from 8-10 to several hundred, depending on your total bandwidth, +shared bandwidth, and locally-generated traffic. +The second number is the number of peers seen in the last hour or so. +Do not be concerned if these numbers vary widely. +[Enable graphing].
    • +
  • Fast: +This is the number of peers you use for building client tunnels. It is generally in the +range 8-30. Your fast peers are shown on the profiles page. +[Enable graphing]
    • +
  • High Capacity: +This is the number of peers you use for building some of your exploratory tunnels. It is generally in the +range 8-75. The fast peers are included in the high capacity tier. +Your high capacity peers are shown on the profiles page. +[Enable graphing]
    • +
  • Well Integrated: +This is the number of peers you use for network database inquiries. +These are usually the "floodfill" peers. +Your well integrated peers are shown on the bottom of the profiles page.
    • +
  • Known: +This is the total number of routers you know about. +They are listed on the network database page. +This may range from under 100 to 1000 or more. +This number is not the total size of the network; +it may vary widely depending on your total bandwidth, +shared bandwidth, and locally-generated traffic. +I2P does not require a router to know every other router.
    • +

Bandwidth in/out

+Should be self-explanatory. All values are in bytes per second, not bits per second. +Change your bandwidth limits on the configuration page. +Bandwidth is graphed by default.
+ +

Local destinations

+The local applications connecting through your router. +These may be clients started through I2PTunnel +or external programs connecting through SAM, BOB, or directly to I2CP. +

Tunnels in/out

+The actual tunnels are shown on the the tunnels page.
    +
  • Exploratory: +Tunnels built by your router and used for communication with the floodfill peers, +building new tunnels, and testing existing tunnels.
    • +
  • Client: +Tunnels built by your router for each client's use.
    • +
  • Participating: +Tunnels built by other routers through your router. +This may vary widely depending on network demand, your +shared bandwidth, and amount of locally-generated traffic. +The recommended method for limiting participating tunnels is +to change your share percentage on the configuration page. +You may also limit the total number by setting router.maxParticipatingTunnels=nnn on +the advanced configuration page. [Enable graphing].
    • +
  • Share ratio: +The number of participating tunnels you route for others, divided by the total number of hops in +all your exploratory and client tunnels. +A number greater than 1.00 means you are contributing more tunnels to the network than you are using.
    • +
+ +

Congestion

+Some basic indications of router overload:
    +
  • Job lag: +How long jobs are waiting before execution. The job queue is listed on the jobs page. +Unfortunately, there are several other job queues in the router that may be congested, +and their status is not available in the router console. +The job lag should generally be zero. +If it is consistently higher than 500ms, your computer is very slow, or the +router has serious problems. +[Enable graphing].
    • +
  • Message delay: +How long an outbound message waits in the queue. +This should generally be a few hundred milliseconds or less. +If it is consistently higher than 1000ms, your computer is very slow, +or you should adjust your bandwidth limits, or your (bittorrent?) clients +may be sending too much data and should have their transmit bandwidth limit reduced. +[Enable graphing] (transport.sendProcessingTime).
    • +
  • Tunnel lag: +This is the round trip time for a tunnel test, which sends a single message +out a client tunnel and in an exploratory tunnel, or vice versa. +It should usually be less than 5 seconds. +If it is consistently higher than that, your computer is very slow, +or you should adjust your bandwidth limits, or there are network problems. +[Enable graphing] (tunnel.testSuccessTime).
    • +
  • Handle backlog: +This is the number of pending requests from other routers to build a +participating tunnel through your router. +It should usually be close to zero. +If it is consistently high, your computer is too slow, +and you should reduce your share bandwidth limits.
    • +
  • Accepting/Rejecting: +Your router's status on accepting or rejecting +requests from other routers to build a +participating tunnel through your router. +Your router may accept all requests, accept or reject a percentage of requests, +or reject all requests for a number of reasons, to control +the bandwidth and CPU demands and maintain capacity for +local clients.