Ignore:
Timestamp:
Sep 19, 2018 10:37:37 AM (23 months ago)
Author:
slumlord <slumlord@…>
Branches:
master
Children:
4369b7d
Parents:
281c5f57
Message:

#2298 - Improve formatting to make translation-related activity easier; More details on trac

File:
1 edited

Legend:

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

    r281c5f57 r46ac0087  
    11<h2>Summary Bar Information</h2>
    22
    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>.
     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.
     4You may also customize the sections that appear on the Summary Bar and their positioning on the <a href="configsidebar">Summary Bar Configuration page</a>.
    45</p>
    56
     
    910<li>
    1011<b>Local Identity:</b>
    11 If 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>
     12If you hover over the "Router Info" heading, your truncated router identity will be shown (the first four characters (24 bits) of your 44-character (256-bit) Base64 router hash).
     13The full hash is shown on your <a href="netdb?r=.">Network Database entry</a>.
     14Never reveal this to anyone, as your router identity is uniquely linked to your IP address in the network database.</li>
    1215<li>
    1316<b>Version:</b>
    14 The 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.
     17The version of the I2P software you are running.
     18If a new version is available, you will be notified in the Summary Bar.
     19It is recommended to keep your router up to date to ensure optimal performance and security.
     20Router updates are usually made available on average every 2-3 months.
    1521</li>
    1622
    1723<li>
    1824<b>Clock Skew:</b>
    19 The 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>.
     25The skew (offset) of your computer's clock relative to the network-synced time (if known).
     26I2P requires your computer's time be accurate.
     27If the skew is more than a few seconds, please correct the problem by adjusting your computer's time.
     28If I2P cannot connect to the internet, a reading of 0ms may be indicated.
     29<b>Note:</b> This is only displayed in the "Router Information (advanced)" section.
     30You may add this section to your Summary Bar on the <a href="configsidebar">Summary Bar Configuration page</a>.
    2031</li>
    2132
    2233<li>
    2334<b>Memory:</b>
    24 This 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>.
     35This indicates the amount of RAM I2P is using, and the total amount available, allocated by Java.
     36The 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.
     37You can allocate more RAM by editing your <code>wrapper.config</code> file which is normally located in the I2P application directory.
     38You will need to edit the <code>wrapper.java.maxmemory</code> parameter, which by default is set to 128(MB).
     39<b>Note:</b> Memory usage is only displayed in the "Router Information (advanced)" section or on the "Memory Usage Bar", both of which may be added to your Summary Bar on the <a href="configsidebar">Summary Bar Configuration page</a>.
    2540</li>
    2641
     
    3954<ul>
    4055<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>.
     56<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.
     57This may range from 8-10 to several hundred, depending on your total bandwidth, shared bandwidth, and locally-generated traffic.
     58The second number is the number of peers seen in the last hour or so.
     59Do not be concerned if these numbers vary widely.
     60<a href="configstats#router.activePeers">[Enable graphing]</a>.
    4261</li>
    4362<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>
     63<b>Fast:</b> This is the number of peers your router has available for building client tunnels.
     64It is generally in the range 8-30. Your fast peers are shown on the <a href="profiles">Profiles page</a>.
     65<a href="configstats#router.fastPeers">[Enable graphing]</a>
    4566</li>
    4667<li><b>High Capacity:</b>
    47 This 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>
     68This is the number of peers your router has available for building your exploratory tunnels which are used to determine network performance.
     69It is generally in the range 8-75.
     70The fast peers are included in the high capacity tier.
     71Your high capacity peers are shown on the <a href="profiles">Profiles page</a>.
     72<a href="configstats#router.highCapacityPeers">[Enable graphing]</a>
    4873</li>
    4974<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>.
     75<b>Integrated:</b> This is the number of peers your router will use for network database inquiries.
     76These are usually the "floodfill" routers which are responsible for maintaining network integrity.
     77Your well integrated peers are shown on the bottom of the <a href="profiles">Profiles page</a>.
    5178</li>
    5279<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.
     80<b>Known:</b> This is the total number of peers that are known by your router.
     81They are listed on the <a href="netdb">Network Database page</a>.
     82This may range from under 100 to 1000 or more.
     83This number is not the total size of the network; it may vary widely depending on your total bandwidth, shared bandwidth, and locally-generated traffic.
     84I2P does not require a router to know every other router in the network.
    5485</li>
    5586</ul>
     
    5788<h3>Bandwidth In/Out</h3>
    5889
    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>
     90<p> This section indicates your average bandwidth speeds and total usage for the session.
     91All values are in bytes per second, not bits per second.
     92You may change your bandwidth limits on the <a href="config">Bandwidth Configuration page</a>.
     93The 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.
     94If you are unsure of your network's speed, using a service such as <a href="https://speedtest.net/">SpeedTest</a> or similar will give you a good indication of your bandwidth capability.
     95Your upstream share amount (KBps Out) will determine your overall contribution to the network.
     96Bandwidth is <a href="graphs">graphed</a> by default.</p>
    6097
    6198<h3>Local Destinations</h3>
    6299
    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>
     100<p>These are the local services provided by your router.
     101They may be clients started through the <a href="i2ptunnelmgr">Tunnel Manager</a> or external programs connecting through SAM, BOB, or directly to I2CP.
     102By default, most of your client services (mail, http proxy, IRC) will share the same set of tunnels (for performance reasons) and be listed as "Shared Clients" and "Shared Clients(DSA)".
     103However, 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.
     104This can be done by unchecking the "Share tunnels with other clients&hellip;" option listed under "Shared Clients" 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>
    64105
    65106<h3>Tunnels</h3>
     
    75116</li>
    76117<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>.
     118<b>Participating:</b> Tunnels built by other routers through your router.
     119This may vary widely depending on network demand, your shared bandwidth, and amount of locally-generated traffic.
     120The recommended method for limiting participating tunnels is to change your share percentage on the <a  href="config">Bandwidth Configuration page</a>.
     121You may also limit the total number by setting <code>router.maxParticipatingTunnels=nnn</code> on the <a href="configadvanced">Advanced configuration page</a>.
     122<a href="configstats#tunnel.participatingTunnels">[Enable graphing]</a>.
    78123</li>
    79124<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.
     125<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.
     126A number greater than 1.00 means you are contributing more tunnels to the network than you are using.
    81127</li>
    82128</ul>
    83129
    84130<h3>Congestion</h3>
    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>
     131<p><b>Note:</b> This section is not enabled by default.
     132You may enable it on the <a href="configsidebar">Summary Bar Configuration page</a>.</p>
    86133<p>Some basic indications of router overload:</p>
    87134
    88135<ul>
    89136<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>.
     137<b>Job Lag:</b> How long jobs are waiting before execution.
     138The job queue is listed on the <a href="jobs">Jobs page</a>.
     139Unfortunately, there are several other job queues in the router that may be congested, and their status is not available in the router console.
     140The job lag should generally be zero.
     141If it is consistently higher than 500ms, your computer is very slow, your network is experiencing connectivity issues, or the router has serious problems.
     142<a href="configstats#jobQueue.jobLag">[Enable graphing]</a>.
    91143</li>
    92144<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).
     145<b>Message Delay:</b> How long an outbound message waits in the queue.
     146This should generally be a few hundred milliseconds or less.
     147If 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.
     148<a href="configstats#transport.sendProcessingTime">[Enable graphing]</a> (transport.sendProcessingTime).
    94149</li>
    95150
     
    106161
    107162<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.
     163<b>Accepting/Rejecting:</b> Your router's status on accepting or rejecting requests from other routers to build a participating tunnel through your router.
     164Your 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.
     165<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.
    109166</li>
    110167</ul>
Note: See TracChangeset for help on using the changeset viewer.