AGentooCat/i2p.i2p
1
0
Fork 0
forked from I2P_Developers/i2p.i2p
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
slumlord
2018-09-19 10:37:37 +00:00
parent 281c5f579f
commit 46ac008775
4 changed files with 223 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
apps/routerconsole/jsp/help-advancedsettings.jsi
View File

@@ -1,6 +1,10 @@
<h2>Advanced Router Configuration</h2>
<p class="infohelp">The router configuration options listed below are not available in the user interface, usually because they are rarely used or provide access to advanced settings that most users will not need. This is not a comprehensive list. Some settings will require a restart of the router to take effect. Note that all settings are case sensitive. You will need to edit your <code>router.config</code> file to add options, or, once you have added <code>routerconsole.advanced=true</code> to the router.config file, you may edit settings within the console on the <a href="/configadvanced">Advanced Configuration page</a>.</p>
<p class="infohelp">The router configuration options listed below are not available in the user interface, usually because they are rarely used or provide access to advanced settings that most users will not need.
This is not a comprehensive list.
Some settings will require a restart of the router to take effect.
Note that all settings are case sensitive.
You will need to edit your <code>router.config</code> file to add options, or, once you have added <code>routerconsole.advanced=true</code> to the router.config file, you may edit settings within the console on the <a href="/configadvanced">Advanced Configuration page</a>.</p>
<table id="configinfo"> <!-- sections separated for legibility -->
@@ -9,7 +13,10 @@
<tr><th>routerconsole.advanced={true|false}</th></tr>
<tr><td class="infowarn">Only set this to true if you know what you are doing!</td></tr>
<tr><td>When set to true, additional functionality will be enabled in the console and the user will be able to edit settings directly on the <a href="/configadvanced">Advanced Configuration page</a>. Extra display options are provided in the <a href="/netdb">Network Database section</a>, including the <a href="/netdb?f=3">Sybil Analysis tool</a>, and there are additional configuration options on the <a href="/configclients">Clients Configuration page</a>. This will also enable the installation of unsigned updates, manual configuration of the news URL, and the installation of plugins. You may also wish to enable the "Advanced" sidebar section on the <a href="/configsidebar">Summary Bar Configuration page</a>.</td></tr>
<tr><td>When set to true, additional functionality will be enabled in the console and the user will be able to edit settings directly on the <a href="/configadvanced">Advanced Configuration page</a>.
Extra display options are provided in the <a href="/netdb">Network Database section</a>, including the <a href="/netdb?f=3">Sybil Analysis tool</a>, and there are additional configuration options on the <a href="/configclients">Clients Configuration page</a>.
This will also enable the installation of unsigned updates, manual configuration of the news URL, and the installation of plugins.
You may also wish to enable the "Advanced" sidebar section on the <a href="/configsidebar">Summary Bar Configuration page</a>.</td></tr>
<tr><th>routerconsole.browser={/path/to/browser}</th></tr>
<tr><td>This setting allows the manual selection of the browser which I2P will launch on startup (if the console is <a href="/configservice#browseronstart">configured</a> to launch a browser on startup), overriding the OS default browser.</td></tr>
@@ -18,25 +25,34 @@
<tr><td>If you wish to install unsigned (.zip) I2P updates, this should be added to your <code>router.config</code> file unless you have already configured <code>routerconsole.advanced=true</code>, in which case this option is already provisioned.</td></tr>
<tr><th>router.updateUnsignedURL={url}</th></tr>
<tr><td>This setting allows you to configure the update url for the unsigned update feature, if enabled. The url should end with <code>/i2pupdate.zip</code>. Note: do not install unsigned updates unless you trust the source of the update!</td></tr>
<tr><td>This setting allows you to configure the update url for the unsigned update feature, if enabled.
The url should end with <code>/i2pupdate.zip</code>.
Note: do not install unsigned updates unless you trust the source of the update!</td></tr>
<tr><th>routerconsole.enablePluginInstall={true|false}</th></tr>
<tr><td>When set to true, this enables plugin installation on the <a href="/configplugins">Plugin Configuration page</a>. Setting <code>routerconsole.advanced=true</code> will also enable this feature. [Enabled by default]</td></tr>
<tr><td>When set to true, this enables plugin installation on the <a href="/configplugins">Plugin Configuration page</a>.
Setting <code>routerconsole.advanced=true</code> will also enable this feature.
[Enabled by default]</td></tr>
<tr><th>routerconsole.allowUntrustedPlugins={true|false}</th></tr>
<tr><td>Plugins signed with the cryptographic key of the developer are the recommended format, but if you wish to install unsigned plugins you can set this to true. Note that you may still encounter issues attempting to install an unsigned plugin if the developer has included additional checks in the plugin build process.</td></tr>
<tr><td>Plugins signed with the cryptographic key of the developer are the recommended format, but if you wish to install unsigned plugins you can set this to true.
Note that you may still encounter issues attempting to install an unsigned plugin if the developer has included additional checks in the plugin build process.</td></tr>
<tr><th>routerconsole.showSearch={true|false}</th></tr>
<tr><td>When set to true, a configurable search bar will appear on the <a href="/home">console homepage</a>. Additional searches may then be added on the <a href="/confighome">home configuration page</a>.</td></tr>
<tr><td>When set to true, a configurable search bar will appear on the <a href="/home">console homepage</a>.
Additional searches may then be added on the <a href="/confighome">home configuration page</a>.</td></tr>
<tr><th>router.buildHandlerThreads={n}</th></tr>
<tr><td>Allocate number of processor threads for building tunnels. If your processor supports hyperthreading or simultaneous multithreading, you may multiply the number of processor cores by 2 to get the maximum number of threads to allocate, otherwise number of processor cores = maximum number of threads available. Note that you may wish to allocate less than the theoretical maximum to ensure you have headroom for other tasks.</td></tr>
<tr><td>Allocate number of processor threads for building tunnels.
If your processor supports hyperthreading or simultaneous multithreading, you may multiply the number of processor cores by 2 to get the maximum number of threads to allocate, otherwise number of processor cores = maximum number of threads available.
Note that you may wish to allocate less than the theoretical maximum to ensure you have headroom for other tasks.</td></tr>
<tr><th>router.hideFloodfillParticipant={true|false}</th></tr>
<tr><td>When set to true, if your router is serving as a floodfill for the network, your <a href="/configadvanced#ffconf">floodfill participation</a> will be hidden from other routers.</td></tr>
<tr><th>router.maxParticipatingTunnels={n}</th></tr>
<tr><td>Determines the maximum number of participating tunnels the router can build. To disable participation completely, set to 0.</td></tr>
<tr><td>Determines the maximum number of participating tunnels the router can build.
To disable participation completely, set to 0.</td></tr>
<tr><th>router.networkDatabase.flat={true|false}</th></tr>
<tr><td>When set to true, the router info files stored in your profile's netDB directory will not be split into 64 sub-directories.

146
apps/routerconsole/jsp/help-faq.jsi
View File

@@ -1,20 +1,29 @@
<h2>Abridged I2P FAQ</h2>
<p class="infohelp">This is a shortened version of the official FAQ. For the full version, please visit <a href="https://geti2p.net/faq" target="_blank">https://geti2p.net/faq</a> or <a href="http://i2p-projekt.i2p/faq" target="_blank">http://i2p-projekt.i2p/faq</a>.
<p class="infohelp">This is a shortened version of the official FAQ.
For the full version, please visit <a href="https://geti2p.net/faq" target="_blank">https://geti2p.net/faq</a> or <a href="http://i2p-projekt.i2p/faq" target="_blank">http://i2p-projekt.i2p/faq</a>.
<h3>My router has been up for several minutes and has zero or very few connections</h3>
<p>If after a few minutes of uptime your router is indicating 0 Active Peers and 0 Known Peers, with a notification in the sidebar that you need to check your network connection, verify that you can access the internet. If your internet connection is functional, you may need to unblock Java in your firewall. Otherwise, you may need to reseed your I2P router. Visit the <a href="/configreseed#reseedconfig">Reseed Configuration page</a> and click the <i>Save Changes and Reseed Now</i> button.</p>
<p>If after a few minutes of uptime your router is indicating 0 Active Peers and 0 Known Peers, with a notification in the sidebar that you need to check your network connection, verify that you can access the internet.
If your internet connection is functional, you may need to unblock Java in your firewall.
Otherwise, you may need to reseed your I2P router. Visit the <a href="/configreseed#reseedconfig">Reseed Configuration page</a> and click the "Save Changes and Reseed Now" button.</p>
<h3>My router has very few active peers, is this OK?</h3>
<p>If your router has 10 or more active peers, everything is fine. The router should maintain connections to a few peers at all times. The best way to stay "better-connected" to the network is to <a href="/config">share more bandwidth</a>.</p>
<p>If your router has 10 or more active peers, everything is fine.
The router should maintain connections to a few peers at all times.
The best way to stay "better-connected" to the network is to <a href="/config">share more bandwidth</a>.</p>
<h3 id="addressbooksubs">I'm missing lots of hosts in my addressbook. What are some good subscription links?</h3>
<p>The default subscription is to <code>http://i2p-projekt.i2p/hosts.txt</code> which is seldom updated. If you don't have another subscription, you may often have to use "jump" links which is much slower but ensures that your addressbook is only populated by sites you use (in addition to the default subscription addresses). To speed up browsing on I2P, it's a good idea to add some addressbook subscriptions.</p>
<p>The default subscription is to <code>http://i2p-projekt.i2p/hosts.txt</code> which is seldom updated.
If you don't have another subscription, you may often have to use "jump" links which is much slower but ensures that your addressbook is only populated by sites you use (in addition to the default subscription addresses).
To speed up browsing on I2P, it's a good idea to add some addressbook subscriptions.</p>
<p>Here are some other public addressbook subscription links. You may wish to add one or two to your <a href="/susidns/subscriptions">susidns subscription list</a>. In the event that addresses conflict in the subscriptions, the lists placed at the top of your susidns configuration will take precedence over those placed further down.</p>
<p>Here are some other public addressbook subscription links.
You may wish to add one or two to your <a href="/susidns/subscriptions">susidns subscription list</a>.
In the event that addresses conflict in the subscriptions, the lists placed at the top of your susidns configuration will take precedence over those placed further down.</p>
<ul>
<li><code>http://stats.i2p/cgi-bin/newhosts.txt</code></li>
@@ -22,59 +31,132 @@
<li><code>http://identiguy.i2p/hosts.txt</code></li>
</ul>
<p>Note that subscribing to a hosts.txt service is an act of trust, as a malicious subscription could give you incorrect addresses, so be careful subscribing to lists from unknown sources. The operators of these services may have various policies for listing hosts. Presence on this list does not imply endorsement.</p>
<p>Note that subscribing to a hosts.txt service is an act of trust, as a malicious subscription could give you incorrect addresses, so be careful subscribing to lists from unknown sources.
The operators of these services may have various policies for listing hosts.
Presence on this list does not imply endorsement.</p>
<h3>How do I access IRC, BitTorrent, or other services on the regular Internet?</h3>
<p>Unless an outproxy has been set up for the service you want to connect to, this is not possible. There are only three types of outproxies running right now: HTTP, HTTPS, and email. Note that there is currently no publicly listed SOCKS outproxy. If this type of service is required, try <a href="https://torproject.org/" target="_blank">Tor</a>.</p>
<p>Unless an outproxy has been set up for the service you want to connect to, this is not possible.
There are only three types of outproxies running right now: HTTP, HTTPS, and email.
Note that there is currently no publicly listed SOCKS outproxy.
If this type of service is required, try <a href="https://torproject.org/" target="_blank">Tor</a>.</p>
<h3>How do I configure my browser to access .i2p websites?</h3>
<p>You will need to configure your browser to use the HTTP proxy server (by default on host: <code>127.0.0.1</code> port: <code>4444</code>). See the <a href="https://geti2p.net/en/about/browser-config" target="_blank">Browser Proxy Configuration Guide</a> for a more detailed explanation.</p>
<p>You will need to configure your browser to use the HTTP proxy server (by default on host: <code>127.0.0.1</code> port: <code>4444</code>).
See the <a href="https://geti2p.net/en/about/browser-config" target="_blank">Browser Proxy Configuration Guide</a> for a more detailed explanation.</p>
<h3>What is an eepsite?</h3>
<p>An eepsite is a website that is hosted anonymously on the I2P network - you can access it by configuring your web browser to use I2P's HTTP proxy (see above) and browsing to the <code>.i2p</code> suffixed website (e.g. <a href="http://i2p-projekt.i2p" target="_blank">http://i2p-projekt.i2p</a>). Also ensure your browser is configured to resolve DNS remotely when using the proxy to avoid DNS leaks.</p>
<p>An eepsite is a website that is hosted anonymously on the I2P network - you can access it by configuring your web browser to use I2P's HTTP proxy (see above) and browsing to the <code>.i2p</code> suffixed website (e.g. <a href="http://i2p-projekt.i2p" target="_blank">http://i2p-projekt.i2p</a>).
Also ensure your browser is configured to resolve DNS remotely when using the proxy to avoid DNS leaks.</p>
<h3>Most of the eepsites are down?</h3>
<p>If you consider every eepsite that has ever been created, yes, most of them are down. People and eepsites come and go. A good way to get started in I2P is check out a list of eepsites that are currently up. <a href="http://identiguy.i2p" target="_blank">http://identiguy.i2p</a> tracks active eepsites.</p>
<p>If you consider every eepsite that has ever been created, yes, most of them are down.
People and eepsites come and go.
A good way to get started in I2P is check out a list of eepsites that are currently up.
<a href="http://identiguy.i2p" target="_blank">http://identiguy.i2p</a> tracks active eepsites.</p>
<h3>How do I connect to IRC within I2P?</h3>
<p>A tunnel to the main IRC server network within I2P, Irc2P, is created when I2P is installed (see the <a href="/i2ptunnelmgr">I2P Tunnel Manager</a>), and is automatically started when the I2P router starts. To connect to it, tell your IRC client to connect to server: <code>127.0.0.1</code> port: <code>6668</code>.</p>
<p>A tunnel to the main IRC server network within I2P, Irc2P, is created when I2P is installed (see the <a href="/i2ptunnelmgr">I2P Tunnel Manager</a>), and is automatically started when the I2P router starts.
To connect to it, tell your IRC client to connect to server: <code>127.0.0.1</code> port: <code>6668</code>.</p>
<p>XChat-like client users can create a new network with the server <code>127.0.0.1/6668</code> (remember to tick <i>Bypass proxy server</i> if you have a proxy server configured), or you can connect with the command <code>/server 127.0.0.1 6668</code>. Different IRC clients may vary the syntax.</p>
<p>HexChat-like client users can create a new network with the server <code>127.0.0.1/6668</code> (remember to tick "Bypass proxy server" if you have a proxy server configured), or you can connect with the command <code>/server 127.0.0.1 6668</code>.
Different IRC clients may require a different command, consult your IRC client's manual for more information.</p>
<h3>What ports does I2P use?</h3>
<table id="portfaq">
<tr><th colspan="3">LOCAL PORTS</th></tr>
<tr><td colspan="3" class="infohelp">These are the local I2P port mappings, listening only to local connections by default, except where noted. Unless you require access from other machines, they should only be accessible from localhost.</td></tr>
<tr><td colspan="3" class="infohelp">These are the local I2P port mappings, listening only to local connections by default, except where noted.
Unless you require access from other machines, they should only be accessible from localhost.</td></tr>
<tr><th>Port</th><th>Function</th><th>Notes</th></tr>
<tr><td>1900</td><td>UPnP SSDP UDP multicast listener</td><td>Cannot be changed. Binds to all interfaces. Can be disabled on the <a href="/confignet">Network Configuration page</a>.</td></tr>
<tr><td>2827</td><td>BOB bridge</td><td>A higher level socket API for clients. Can be enabled/disabled on the <a href="/configclients">Client Configuration page</a>. Can be changed in the <code>bob.config</code> file. [Disabled by default]</td></tr>
<tr><td>4444</td><td>HTTP proxy</td><td>Can be disabled or changed in the <a href="/i2ptunnelmgr">I2P Tunnel Manager</a>. Can also be configured to bind to a specific interface or all interfaces.</td></tr>
<tr><td>4445</td><td>HTTPS proxy</td><td>Can be disabled or changed in the <a href="/i2ptunnelmgr">I2P Tunnel Manager</a>. Can also be configured to bind to a specific interface or all interfaces.</td></tr>
<tr><td>6668</td><td>IRC proxy</td><td>Can be disabled or changed in the <a href="/i2ptunnelmgr">I2P Tunnel Manager</a>. Can also be configured to bind to a specific interface or all interfaces.</td></tr>
<tr><td>7652</td><td>UPnP HTTP TCP event listener</td><td>Binds to the LAN address. Can be changed with advanced config <code>i2np.upnp.HTTPPort=nnnn</code>. Can be disabled on the <a href="/confignet">Network Configuration page</a>.</td></tr>
<tr><td>7653</td><td>UPnP SSDP UDP search response listener</td><td>Binds to all interfaces. Can be changed with advanced config <code>i2np.upnp.SSDPPort=nnnn</code>. Can be disabled on the <a href="/configclients">Client Configuration page</a>.</td></tr>
<tr><td>7654</td><td>I2P Client Protocol port</td><td>Used by client apps. Can be changed to a different port on the <a href="/configclients">Client Configuration page</a> but this is not recommended. Can be bound to a different interface or all interfaces, or disabled, on the <a href="/configclients">Client Configuration page</a>.</td></tr>
<tr><td>7655</td><td>UDP for SAM bridge</td><td>A higher level socket API for clients. Only opened when a SAM V3 client requests a UDP session. Can be enabled/disabled on the <a href="/configclients"> Client Configuration page</a>. Can be changed in the <code>clients.config</code> file with the SAM command line option <code>sam.udp.port=nnnn</code>.</td></tr>
<tr><td>7656</td><td>SAM bridge</td><td>A higher level socket API for clients. Can be enabled/disabled on the <a href="/configclients">Client Configuration page</a>. Can be changed in the <code>clients.config</code> file. [Disabled by default]</td></tr>
<tr><td>7657</td><td>I2P Router Console (Web interface)</td><td>Can be disabled in the <code>clients.config</code> file. Can also be configured to bind to a specific interface or all interfaces in that file. If you make the Router Console available over the network, you might wish to <a href="/configui#passwordheading">enforce an access password</a> to prevent unauthorized access.</td></tr>
<tr><td>7658</td><td>I2P Web Server</td><td>Can be disabled in the <code>clients.config</code> file. Can also be configured to bind to a specific interface or all interfaces in the <code>jetty.xml</code> file.</td>
<tr><td>1900</td>
<td>UPnP SSDP UDP multicast listener</td>
<td>Cannot be changed.
Binds to all interfaces.
Can be disabled on the <a href="/confignet">Network Configuration page</a>.</td></tr>
<tr><td>2827</td>
<td>BOB bridge</td>
<td>A higher level socket API for clients.
Can be enabled/disabled on the <a href="/configclients">Client Configuration page</a>.
Can be changed in the <code>bob.config</code> file. [Disabled by default]</td></tr>
<tr><td>4444</td>
<td>HTTP proxy</td>
<td>Can be disabled or changed in the <a href="/i2ptunnelmgr">I2P Tunnel Manager</a>.
Can also be configured to bind to a specific interface or all interfaces.</td></tr>
<tr><td>4445</td>
<td>HTTPS proxy</td>
<td>Can be disabled or changed in the <a href="/i2ptunnelmgr">I2P Tunnel Manager</a>.
Can also be configured to bind to a specific interface or all interfaces.</td></tr>
<tr><td>6668</td>
<td>IRC proxy</td>
<td>Can be disabled or changed in the <a href="/i2ptunnelmgr">I2P Tunnel Manager</a>.
Can also be configured to bind to a specific interface or all interfaces.</td></tr>
<tr><td>7652</td>
<td>UPnP HTTP TCP event listener</td>
<td>Binds to the LAN address. Can be changed with advanced config <code>i2np.upnp.HTTPPort=nnnn</code>.
Can be disabled on the <a href="/confignet">Network Configuration page</a>.</td></tr>
<tr><td>7653</td>
<td>UPnP SSDP UDP search response listener</td>
<td>Binds to all interfaces.
Can be changed with advanced config <code>i2np.upnp.SSDPPort=nnnn</code>.
Can be disabled on the <a href="/configclients">Client Configuration page</a>.</td></tr>
<tr><td>7654</td>
<td>I2P Client Protocol port</td>
<td>Used by client apps. Can be changed to a different port on the <a href="/configclients">Client Configuration page</a> but this is not recommended.
Can be bound to a different interface or all interfaces, or disabled, on the <a href="/configclients">Client Configuration page</a>.</td></tr>
<tr><td>7655</td>
<td>UDP for SAM bridge</td>
<td>A higher level socket API for clients.
Only opened when a SAM V3 client requests a UDP session.
Can be enabled/disabled on the <a href="/configclients"> Client Configuration page</a>.
Can be changed in the <code>clients.config</code> file with the SAM command line option <code>sam.udp.port=nnnn</code>.</td></tr>
<tr><td>7656</td>
<td>SAM bridge</td>
<td>A higher level socket API for clients.
Can be enabled/disabled on the <a href="/configclients">Client Configuration page</a>.
Can be changed in the <code>clients.config</code> file. [Disabled by default]</td></tr>
<tr><td>7657</td>
<td>I2P Router Console (Web interface)</td>
<td>Can be disabled in the <code>clients.config</code> file.
Can also be configured to bind to a specific interface or all interfaces in that file.
If you make the Router Console available over the network, you might wish to <a href="/configui#passwordheading">enforce an access password</a> to prevent unauthorized access.</td></tr>
<tr><td>7658</td>
<td>I2P Web Server</td>
<td>Can be disabled in the <code>clients.config</code> file.
Can also be configured to bind to a specific interface or all interfaces in the <code>jetty.xml</code> file.</td>
</tr>
<tr><td>7659</td><td>Outgoing mail to smtp.postman.i2p</td><td>Can be disabled or changed in the <a href="/i2ptunnelmgr">I2P Tunnel Manager</a>. Can also be configured to bind to a specific interface or all interfaces.</td></tr>
<tr><td>7660</td><td>Incoming mail from pop.postman.i2p</td><td>Can be disabled or changed in the <a href="/i2ptunnelmgr">I2P Tunnel Manager</a>. Can also be configured to bind to a specific interface or all interfaces.</td></tr>
<tr><td>8998</td><td>mtn.i2p2.i2p (I2P's Monotone DVCS)</td><td>Can be disabled or changed in the <a href="/i2ptunnelmgr">I2P Tunnel Manager</a>. Can also be configured to bind to a specific interface or all interfaces. [Disabled by default]</td></tr>
<tr><td>31000</td><td>Local connection to wrapper control channel port</td><td>Outbound to 32000 only, does not listen on this port. Starts at 31000 and will increment until 31999 looking for a free port. To change, see the <a href="http://wrapper.tanukisoftware.com/doc/english/prop-port.html" target="_blank">wrapper documentation</a>.</td></tr>
<tr><td>32000</td><td>Local control channel for the service wrapper</td><td>To change, see the <a href="http://wrapper.tanukisoftware.com/doc/english/prop-port.html" target="_blank">wrapper documentation</a>.</td></tr>
<tr><td>7659</td>
<td>Outgoing mail to smtp.postman.i2p</td>
<td>Can be disabled or changed in the <a href="/i2ptunnelmgr">I2P Tunnel Manager</a>.
Can also be configured to bind to a specific interface or all interfaces.</td></tr>
<tr><td>7660</td>
<td>Incoming mail from pop.postman.i2p</td>
<td>Can be disabled or changed in the <a href="/i2ptunnelmgr">I2P Tunnel Manager</a>.
Can also be configured to bind to a specific interface or all interfaces.</td></tr>
<tr><td>8998</td>
<td>mtn.i2p2.i2p (I2P's Monotone DVCS)</td>
<td>Can be disabled or changed in the <a href="/i2ptunnelmgr">I2P Tunnel Manager</a>.
Can also be configured to bind to a specific interface or all interfaces. [Disabled by default]</td></tr>
<tr><td>31000</td>
<td>Local connection to wrapper control channel port</td>
<td>Outbound to 32000 only, does not listen on this port.
Starts at 31000 and will increment until 31999 looking for a free port.
To change, see the <a href="http://wrapper.tanukisoftware.com/doc/english/prop-port.html" target="_blank">wrapper documentation</a>.</td></tr>
<tr><td>32000</td>
<td>Local control channel for the service wrapper</td>
<td>To change, see the <a href="http://wrapper.tanukisoftware.com/doc/english/prop-port.html" target="_blank">wrapper documentation</a>.</td></tr>
<tr><th colspan="3">INTERNET FACING PORTS</th></tr>
<tr><td colspan="3" class="infohelp">I2P selects a random port between 9000 and 31000 to communicate with other routers when the program is run for the first time, or when your external IP address changes when running in <a href="/confignet#ipchange">Laptop Mode</a>. The <a href="/confignet#udpconfig">selected port</a> is shown on the <a href="/confignet">Network Configuration page</a>.</td></tr>
<tr><td colspan="3" class="infohelp">I2P selects a random port between 9000 and 31000 to communicate with other routers when the program is run for the first time, or when your external IP address changes when running in <a href="/confignet#ipchange">Laptop Mode</a>.
The <a href="/confignet#udpconfig">selected port</a> is shown on the <a href="/confignet">Network Configuration page</a>.</td></tr>
<tr><td colspan="3">Outbound UDP from the <a href="/confignet#udpconfig">random port</a> noted on the Network Configuration page to arbitrary remote UDP ports, allowing replies.</td></tr>
<tr><td colspan="3">Outbound TCP from random high ports to arbitrary remote TCP ports.</td></tr>
<tr><td colspan="3">Inbound UDP to the <a href="/confignet#udpconfig">port</a> noted on the Network Configuration page from arbitrary locations (optional, but recommended).</td></tr>
<tr><td colspan="3">Inbound TCP to the <a href="/confignet#externaltcp">port</a> noted on the Network Configuration page from arbitrary locations (optional, but recommended). <a href="/confignet#tcpconfig">Inbound TCP</a> may be disabled on the Network Configuration page.</td></tr>
<tr><td colspan="3">Inbound TCP to the <a href="/confignet#externaltcp">port</a> noted on the Network Configuration page from arbitrary locations (optional, but recommended).
<a href="/confignet#tcpconfig">Inbound TCP</a> may be disabled on the Network Configuration page.</td></tr>
<tr><td colspan="3">Outbound UDP on port 123, allowing replies: this is necessary for I2P's internal time sync (via SNTP - querying a random SNTP host in <code>pool.ntp.org</code> or another server you specify).</td></tr>
</table>

26
apps/routerconsole/jsp/help-legal.jsi
View File

@@ -12,23 +12,17 @@
<p>On top of the I2P router are a series of client applications, each with their own set of licenses and dependencies:
<ul>
<li><a href="http://i2p-projekt.i2p/i2ptunnel" target="_blank">I2PTunnel</a> - a GPL'ed application written by mihi
that lets you tunnel normal TCP/IP traffic over I2P (such as the http proxy and the irc proxy), with a <a href="/i2ptunnelmgr">browser-based front end.</a></li>
<li><a href="http://i2p-projekt.i2p/i2ptunnel" target="_blank">I2PTunnel</a> - a GPL'ed application written by mihi that lets you tunnel normal TCP/IP traffic over I2P (such as the http proxy and the irc proxy), with a <a href="/i2ptunnelmgr">browser-based front end.</a></li>
<li><a href="/webmail">Susimail</a>, a GPL'ed browser based mail client written by susi23.</li>
<li>The <a href="http://i2p-projekt.i2p/en/docs/naming#addressbook" target="_blank">addressbook application</a>,
written by Ragnarok helps maintain your hosts.txt files, with a <a href="/dns">front end</a> written by susi23.</li>
<li>The <a href="http://i2p-projekt.i2p/en/docs/api/samv3" target="_blank">SAM</a> bridge by human (public domain), an API
which other client applications (such the <a href="http://i2pwiki.i2p/index.php?title=Tahoe-LAFS" target="_blank">I2P Tahoe-LAFS cloud filesystem</a>) can use to interface with I2P.</li>
<li><a href="http://i2p-projekt.i2p/en/misc/jbigi" target="_blank">jbigi</a> - an optimized library for doing large number calculations which uses the
LGPL licensed <a href="http://swox.com/gmp/" target="_blank">GMP</a> library, tuned for various PC architectures.</li>
<li>Launchers for windows users are built with <a href="http://launch4j.sourceforge.net/" target="_blank">Launch4J</a>,
and the installer is built with <a href="http://www.izforge.com/izpack/" target="_blank">IzPack</a>.</li>
<li>The <a href="/">I2P Router Console</a>, built from a streamlined <a href="http://jetty.mortbay.com/jetty/index.html" target="_blank">Jetty Web Server</a> instance
which allows you to deploy standard JSP/Servlet web applications in your router.</li>
<li>Jetty makes use of Apache's <a href="https://docs.oracle.com/javaee/7/api/javax/servlet/package-summary.html" target="_blank">javax.servlet</a>
(javax.servlet.jar) implementation. This product includes software developed by the <a href="http://www.apache.org/" target="_blank">Apache Software Foundation</a>.</li>
<li>The <a href="http://i2p-projekt.i2p/en/docs/naming#addressbook" target="_blank">addressbook application</a>, written by Ragnarok helps maintain your hosts.txt files, with a <a href="/dns">front end</a> written by susi23.</li>
<li>The <a href="http://i2p-projekt.i2p/en/docs/api/samv3" target="_blank">SAM</a> bridge by human (public domain), an API which other client applications (such the <a href="http://i2pwiki.i2p/index.php?title=Tahoe-LAFS" target="_blank">I2P Tahoe-LAFS cloud filesystem</a>) can use to interface with I2P.</li>
<li><a href="http://i2p-projekt.i2p/en/misc/jbigi" target="_blank">jbigi</a> - an optimized library for doing large number calculations which uses the LGPL licensed <a href="http://swox.com/gmp/" target="_blank">GMP</a> library, tuned for various PC architectures.</li>
<li>Launchers for windows users are built with <a href="http://launch4j.sourceforge.net/" target="_blank">Launch4J</a>, and the installer is built with <a href="http://www.izforge.com/izpack/" target="_blank">IzPack</a>.</li>
<li>The <a href="/">I2P Router Console</a>, built from a streamlined <a href="http://jetty.mortbay.com/jetty/index.html" target="_blank">Jetty Web Server</a> instance which allows you to deploy standard JSP/Servlet web applications in your router.</li>
<li>Jetty makes use of Apache's <a href="https://docs.oracle.com/javaee/7/api/javax/servlet/package-summary.html" target="_blank">javax.servlet</a> (javax.servlet.jar) implementation.
This product includes software developed by the <a href="http://www.apache.org/" target="_blank">Apache Software Foundation</a>.</li>
<li>Source for the I2P code and most bundled client applications can be found on our <a href="http://i2p-projekt.i2p/download" target="_blank">download page</a>.</li>
</ul>
<p>For details on other applications available, as well as their licenses, please see the <a href="http://i2p-projekt.i2p/licenses" target="_blank">
license policy</a>. Additional licenses can be found in the <code>licenses</code> sub-directory of your I2P installation.</p>
<p>For details on other applications available, as well as their licenses, please see the <a href="http://i2p-projekt.i2p/licenses" target="_blank"> license policy</a>.
Additional licenses can be found in the <code>licenses</code> sub-directory of your I2P installation.</p>

93
apps/routerconsole/jsp/help-sidebar.jsi
View File

@@ -1,6 +1,7 @@
<h2>Summary Bar Information</h2>
<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>.
<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>.
</p>
<h3>Router Info</h3>
@@ -8,20 +9,34 @@
<ul>
<li>
<b>Local Identity:</b>
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>
If 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).
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>
<li>
<b>Version:</b>
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.
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.
</li>
<li>
<b>Clock Skew:</b>
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>.
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 "Router Information (advanced)" section.
You may add this section to your Summary Bar on the <a href="configsidebar">Summary Bar Configuration page</a>.
</li>
<li>
<b>Memory:</b>
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>.
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 "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>.
</li>
<%
@@ -38,29 +53,55 @@ The router's view of whether it can be contacted by other routers. See <a href="
<ul>
<li>
<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>.
<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>.
</li>
<li>
<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>
<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>
</li>
<li><b>High Capacity:</b>
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>
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>
</li>
<li>
<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>.
<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>.
</li>
<li>
<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.
<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.
</li>
</ul>
<h3>Bandwidth In/Out</h3>
<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>
<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="https://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>
<h3>Local Destinations</h3>
<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>
<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 "Shared Clients" and "Shared Clients(DSA)".
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 "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>
<h3>Tunnels</h3>
@@ -74,23 +115,37 @@ This is the number of peers your router has available for building your explorat
<b>Client:</b> Tunnels built by your router for each client's use.
</li>
<li>
<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>.
<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>.
</li>
<li>
<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.
<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.
</li>
</ul>
<h3>Congestion</h3>
<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>
<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>
<p>Some basic indications of router overload:</p>
<ul>
<li>
<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>.
<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>.
</li>
<li>
<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).
<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).
</li>
<%
@@ -105,7 +160,9 @@ This is the number of peers your router has available for building your explorat
%>
<li>
<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.
<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.
</li>
</ul>