Ignore:
Timestamp:
Oct 25, 2017 9:39:09 AM (3 years ago)
Author:
str4d <str4d@…>
Branches:
master
Children:
cdd89df
Parents:
da9c06e
Message:

/help:

  • Update sidebar help section (en)
  • Remove redundant CSS class from all help section files (li.tidylist)
File:
1 edited

Legend:

Unmodified
Added
Removed
  • apps/routerconsole/jsp/help-sidebar.jsi

    rda9c06e rac833ec  
    1 <h2>Summary Bar Information</h2><p>
    2 Many of the stats on the summary bar may be
    3 <a href="configstats.jsp">configured</a> to be
    4 <a href="graphs.jsp">graphed</a> for further analysis.
    5 </p><h3>General</h3><ul>
    6 <li class="tidylist"><b>Local Identity:</b>
    7 The first four characters (24 bits) of your 44-character (256-bit) Base64 router hash.
    8 The full hash is shown on your <a href="netdb.jsp?r=.">router info page</a>.
    9 Never reveal this to anyone, as your router info contains your IP.</li>
    10 <li class="tidylist"><b>Version:</b>
    11 The version of the I2P software you are running.</li>
     1<h2>Summary Bar Information</h2>
     2
     3<p>Many of the stats on the summary bar may be <a href="configstats">configured</a> to be <a href="graphs">graphed</a> for further analysis. You may also customize the sections that appear on the Summary Bar and their positioning on the <a href="configsidebar">Summary Bar Configuration page</a>.
     4</p>
     5
     6<h3>Router Info</h3>
     7
     8<ul>
     9<li>
     10<b>Local Identity:</b>
     11If you hover over the <i>Router Info</i> heading, your truncated router identity will be shown (the first four characters (24 bits) of your 44-character (256-bit) Base64 router hash). The full hash is shown on your <a href="netdb?r=.">Network Database entry</a>. Never reveal this to anyone, as your router identity is uniquely linked to your IP address in the network database.</li>
     12<li>
     13<b>Version:</b>
     14The version of the I2P software you are running. If a new version is available, you will be notified in the Summary Bar. It is recommended to keep your router up to date to ensure optimal performance and security. Router updates are usually made available on average every 2-3 months.
     15</li>
     16
     17<li>
     18<b>Clock Skew:</b>
     19The skew (offset) of your computer's clock relative to the network-synced time (if known). 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. If I2P cannot connect to the internet, a reading of 0ms may be indicated. <b>Note:</b> This is only displayed in the <i>Router Information (advanced)</i> section. You may add this section to your Summary Bar on the <a href="configsidebar">Summary Bar Configuration page</a>.
     20</li>
     21
     22<li>
     23<b>Memory:</b>
     24This indicates the amount of RAM I2P is using, and the total amount available, allocated by Java. The usage will likely vary considerably within a short timeframe, but if the usage is consistently high relative to the available RAM, this may indicate that you need to increase the ram allocated to the JVM. You can allocate more RAM by editing your <code>wrapper.config</code> file which is normally located in the I2P application directory. You will need to edit the <code>wrapper.java.maxmemory</code> parameter, which by default is set to 128(MB). <b>Note:</b> Memory usage is only displayed in the <i>Router Information (advanced)</i> section or on the <i>Memory Usage Bar</i>, both of which may be added to your Summary Bar on the <a href="configsidebar">Summary Bar Configuration page</a>.
     25</li>
     26
    1227<%
    13 /* <li class="tidylist"><b>Now:</b>
    14 The current time (UTC) and the skew, if any. I2P requires your computer's time be accurate.
    15 If the skew is more than a few seconds, please correct the problem by adjusting
    16 your computer's time.</li> */
     28/*
     29<li>
     30<b>Reachability:</b>
     31The router's view of whether it can be contacted by other routers. See <a href="#confignet">below</a> for more information.</li>
     32*/
    1733%>
    18 <li class="tidylist"><b>Reachability:</b>
    19 The router's view of whether it can be contacted by other routers.
    20 See <a href="#confignet">below</a> for more information.
    21 </li></ul><h3>Peers</h3><ul>
    22 <li class="tidylist"><b>Active:</b>
    23 The first number is the number of peers you've sent or received a message from in the last few minutes.
    24 This may range from 8-10 to several hundred, depending on your total bandwidth,
    25 shared bandwidth, and locally-generated traffic.
    26 The second number is the number of peers seen in the last hour or so.
    27 Do not be concerned if these numbers vary widely.
    28 <a href="configstats.jsp#router.activePeers">[Enable graphing]</a>.</li>
    29 <li class="tidylist"><b>Fast:</b>
    30 This is the number of peers you use for building client tunnels. It is generally in the
    31 range 8-30. Your fast peers are shown on the <a href="profiles.jsp">profiles page</a>.
    32 <a href="configstats.jsp#router.fastPeers">[Enable graphing]</a></li>
    33 <li class="tidylist"><b>High Capacity:</b>
    34 This is the number of peers you use for building some of your exploratory tunnels. It is generally in the
    35 range 8-75. The fast peers are included in the high capacity tier.
    36 Your high capacity peers are shown on the <a href="profiles.jsp">profiles page</a>.
    37 <a href="configstats.jsp#router.highCapacityPeers">[Enable graphing]</a></li>
    38 <li class="tidylist"><b>Well Integrated:</b>
    39 This is the number of peers you use for network database inquiries.
    40 These are usually the "floodfill" peers.
    41 Your well integrated peers are shown on the bottom of the <a href="profiles.jsp">profiles page</a>.</li>
    42 <li class="tidylist"><b>Known:</b>
    43 This is the total number of routers you know about.
    44 They are listed on the <a href="netdb.jsp">network database page</a>.
    45 This may range from under 100 to 1000 or more.
    46 This number is not the total size of the network;
    47 it may vary widely depending on your total bandwidth,
    48 shared bandwidth, and locally-generated traffic.
    49 I2P does not require a router to know every other router.</li>
    50 </ul><h3>Bandwidth in/out</h3>
    51 <p>Should be self-explanatory. All values are in bytes per second, not bits per second.
    52 Change your bandwidth limits on the <a href="config">configuration page</a>.
    53 Bandwidth is <a href="graphs.jsp">graphed</a> by default.</p>
    54 <h3>Local destinations</h3>
    55 <p>The local applications connecting through your router.
    56 These may be clients started through <a href="i2ptunnel/index.jsp">I2PTunnel</a>
    57 or external programs connecting through SAM, BOB, or directly to I2CP.</p>
    5834
    59 <h3>Tunnels in/out</h3>
    60 <p>The actual tunnels are shown on the <a href="tunnels.jsp">the tunnels page</a>.</p>
    61 <ul><li class="tidylist"><b>Exploratory:</b>
    62 Tunnels built by your router and used for communication with the floodfill peers,
    63 building new tunnels, and testing existing tunnels.</li>
    64 <li class="tidylist"><b>Client:</b>
    65 Tunnels built by your router for each client's use.</li>
    66 <li class="tidylist"><b>Participating:</b>
    67 Tunnels built by other routers through your router.
    68 This may vary widely depending on network demand, your
    69 shared bandwidth, and amount of locally-generated traffic.
    70 The recommended method for limiting participating tunnels is
    71 to change your share percentage on the <a href="config">configuration page</a>.
    72 You may also limit the total number by setting <tt>router.maxParticipatingTunnels=nnn</tt> on
    73 the <a href="configadvanced.jsp">advanced configuration page</a>. <a href="configstats.jsp#tunnel.participatingTunnels">[Enable graphing]</a>.</li>
    74 <li class="tidylist"><b>Share ratio:</b>
    75 The number of participating tunnels you route for others, divided by the total number of hops in
    76 all your exploratory and client tunnels.
    77 A number greater than 1.00 means you are contributing more tunnels to the network than you are using.</li>
     35</ul>
     36
     37<h3>Peers</h3>
     38
     39<ul>
     40<li>
     41<b>Active:</b> The first number is the number of peers your router has 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. <a href="configstats#router.activePeers">[Enable graphing]</a>.
     42</li>
     43<li>
     44<b>Fast:</b> This is the number of peers your router has available for building client tunnels. It is generally in the range 8-30. Your fast peers are shown on the <a href="profiles">Profiles page</a>. <a href="configstats#router.fastPeers">[Enable graphing]</a>
     45</li>
     46<li><b>High Capacity:</b>
     47This is the number of peers your router has available for building your exploratory tunnels which are used to determine network performance. 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 <a href="profiles">Profiles page</a>. <a href="configstats#router.highCapacityPeers">[Enable graphing]</a>
     48</li>
     49<li>
     50<b>Integrated:</b> This is the number of peers your router will use for network database inquiries. These are usually the "floodfill" routers which are responsible for maintaining network integrity. Your well integrated peers are shown on the bottom of the <a href="profiles">Profiles page</a>.
     51</li>
     52<li>
     53<b>Known:</b> This is the total number of peers that are known by your router. They are listed on the <a href="netdb">Network Database page</a>. 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 in the network.
     54</li>
     55</ul>
     56
     57<h3>Bandwidth In/Out</h3>
     58
     59<p> This section indicates your average bandwidth speeds and total usage for the session. All values are in bytes per second, not bits per second. You may change your bandwidth limits on the <a href="config">Bandwidth Configuration page</a>. The more bandwidth you make available, the more you help the network and improve your own anonymity, so please take the time to review the settings. If you are unsure of your network's speed, using a service such as <a href="http://speedtest.net/">SpeedTest</a> or similar will give you a good indication of your bandwidth capability. Your upstream share amount (KBps Out) will determine your overall contribution to the network. Bandwidth is <a href="graphs">graphed</a> by default.</p>
     60
     61<h3>Local Destinations</h3>
     62
     63<p>These are the local services provided by your router. They may be clients started through the <a href="i2ptunnelmgr">Tunnel Manager</a> or external programs connecting through SAM, BOB, or directly to I2CP. By default, most of your client services (mail, http proxy, IRC) will share the same set of tunnels (for performance reasons) and be listed as <i>Shared Clients</i> and <i>Shared Clients(DSA)</i>. However, if you experience a tunnel failure, all your services will go offline at the same time, so in some scenarios you may wish to configure client services to use their own set of tunnels. This can be done by unchecking the <i>Share tunnels with other clients&hellip;</i> option listed under <i>Shared Clients</i> on the configuration page of the relevant client service in the Tunnel Manager, after which you will need to restart the client service from the <a href="i2ptunnelmgr">main Tunnel Manager page</a>.</p>
     64
     65<h3>Tunnels</h3>
     66
     67<p>The actual tunnels are shown on the <a href="tunnels">Tunnels page</a>.</p>
     68
     69<ul>
     70<li>
     71<b>Exploratory:</b> Tunnels built by your router and used for communication with the floodfill peers, building new tunnels, and testing existing tunnels.
     72</li>
     73<li>
     74<b>Client:</b> Tunnels built by your router for each client's use.
     75</li>
     76<li>
     77<b>Participating:</b> 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 <a  href="config">Bandwidth Configuration page</a>. You may also limit the total number by setting <code>router.maxParticipatingTunnels=nnn</code> on the <a href="configadvanced">Advanced configuration page</a>. <a href="configstats#tunnel.participatingTunnels">[Enable graphing]</a>.
     78</li>
     79<li>
     80<b>Share Ratio:</b> 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.
     81</li>
    7882</ul>
    7983
    8084<h3>Congestion</h3>
    81 <p>Some basic indications of router overload:</p><ul>
    82 <li class="tidylist"><b>Job lag:</b>
    83 How long jobs are waiting before execution. The job queue is listed on the <a href="jobs.jsp">jobs page</a>.
    84 Unfortunately, there are several other job queues in the router that may be congested,
    85 and their status is not available in the router console.
    86 The job lag should generally be zero.
    87 If it is consistently higher than 500ms, your computer is very slow, or the
    88 router has serious problems.
    89 <a href="configstats.jsp#jobQueue.jobLag">[Enable graphing]</a>.</li>
    90 <li class="tidylist"><b>Message delay:</b>
    91 How long an outbound message waits in the queue.
    92 This should generally be a few hundred milliseconds or less.
    93 If it is consistently higher than 1000ms, your computer is very slow,
    94 or you should adjust your bandwidth limits, or your (bittorrent?) clients
    95 may be sending too much data and should have their transmit bandwidth limit reduced.
    96 <a href="configstats.jsp#transport.sendProcessingTime">[Enable graphing]</a> (transport.sendProcessingTime).</li>
    97 <li class="tidylist"><b>Tunnel lag:</b>
    98 This is the round trip time for a tunnel test, which sends a single message
    99 out a client tunnel and in an exploratory tunnel, or vice versa.
    100 It should usually be less than 5 seconds.
    101 If it is consistently higher than that, your computer is very slow,
    102 or you should adjust your bandwidth limits, or there are network problems.
    103 <a href="configstats.jsp#tunnel.testSuccessTime">[Enable graphing]</a> (tunnel.testSuccessTime).</li>
    104 <li class="tidylist"><b>Handle backlog:</b>
    105 This is the number of pending requests from other routers to build a
    106 participating tunnel through your router.
    107 It should usually be close to zero.
    108 If it is consistently high, your computer is too slow,
    109 and you should reduce your share bandwidth limits.</li>
    110 <li class="tidylist"><b>Accepting/Rejecting:</b>
    111 Your router's status on accepting or rejecting
    112 requests from other routers to build a
    113 participating tunnel through your router.
    114 Your router may accept all requests, accept or reject a percentage of requests,
    115 or reject all requests for a number of reasons, to control
    116 the bandwidth and CPU demands and maintain capacity for
    117 local clients.</li></ul>
     85<p><b>Note:</b> This section is not enabled by default. You may enable it on the <a href="configsidebar">Summary Bar Configuration page</a>.</p>
     86<p>Some basic indications of router overload:</p>
     87
     88<ul>
     89<li>
     90<b>Job Lag:</b> How long jobs are waiting before execution. The job queue is listed on the <a href="jobs">Jobs page</a>. 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, your network is experiencing connectivity issues, or the router has serious problems. <a href="configstats#jobQueue.jobLag">[Enable graphing]</a>.
     91</li>
     92<li>
     93<b>Message Delay:</b> 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. <a href="configstats#transport.sendProcessingTime">[Enable graphing]</a> (transport.sendProcessingTime).
     94</li>
     95
     96<%
     97/*
     98<li>
     99<b>Tunnel lag:</b> 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. Problems may be indicated on the <a href="logs">Logs page</a>. <a href="configstats#tunnel.testSuccessTime">[Enable graphing]</a> (tunnel.testSuccessTime).
     100</li>
     101
     102<li>
     103<b>Handle backlog:</b> 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.</li>
     104*/
     105%>
     106
     107<li>
     108<b>Accepting/Rejecting:</b> 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. <b>Note:</b> It will take at least 10 minutes from your router starting for it to accept building participating tunnels in order to ensure your router is stable and successfully bootstrapped to the network.
     109</li>
     110</ul>
     111
Note: See TracChangeset for help on using the changeset viewer.