diff --git a/apps/routerconsole/jsp/help-advancedsettings.jsi b/apps/routerconsole/jsp/help-advancedsettings.jsi index 9606cfea6e..ebf8c8b54d 100644 --- a/apps/routerconsole/jsp/help-advancedsettings.jsi +++ b/apps/routerconsole/jsp/help-advancedsettings.jsi @@ -1,6 +1,10 @@
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 router.config file to add options, or, once you have added routerconsole.advanced=true to the router.config file, you may edit settings within the console on the Advanced Configuration page.
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 router.config file to add options, or, once you have added routerconsole.advanced=true to the router.config file, you may edit settings within the console on the Advanced Configuration page.
| routerconsole.advanced={true|false} | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Only set this to true if you know what you are doing! | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| When set to true, additional functionality will be enabled in the console and the user will be able to edit settings directly on the Advanced Configuration page. Extra display options are provided in the Network Database section, including the Sybil Analysis tool, and there are additional configuration options on the Clients Configuration page. 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 Summary Bar Configuration page. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| When set to true, additional functionality will be enabled in the console and the user will be able to edit settings directly on the Advanced Configuration page. +Extra display options are provided in the Network Database section, including the Sybil Analysis tool, and there are additional configuration options on the Clients Configuration page. +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 Summary Bar Configuration page. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| routerconsole.browser={/path/to/browser} | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| This setting allows the manual selection of the browser which I2P will launch on startup (if the console is configured to launch a browser on startup), overriding the OS default browser. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
If you wish to install unsigned (.zip) I2P updates, this should be added to your router.config file unless you have already configured routerconsole.advanced=true, in which case this option is already provisioned. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| router.updateUnsignedURL={url} | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This setting allows you to configure the update url for the unsigned update feature, if enabled. The url should end with /i2pupdate.zip. Note: do not install unsigned updates unless you trust the source of the update! | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This setting allows you to configure the update url for the unsigned update feature, if enabled.
+The url should end with /i2pupdate.zip.
+Note: do not install unsigned updates unless you trust the source of the update! | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| routerconsole.enablePluginInstall={true|false} | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
When set to true, this enables plugin installation on the Plugin Configuration page. Setting routerconsole.advanced=true will also enable this feature. [Enabled by default] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
When set to true, this enables plugin installation on the Plugin Configuration page.
+Setting routerconsole.advanced=true will also enable this feature.
+[Enabled by default] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| routerconsole.allowUntrustedPlugins={true|false} | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| routerconsole.showSearch={true|false} | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| When set to true, a configurable search bar will appear on the console homepage. Additional searches may then be added on the home configuration page. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| When set to true, a configurable search bar will appear on the console homepage. +Additional searches may then be added on the home configuration page. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| router.buildHandlerThreads={n} | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| router.hideFloodfillParticipant={true|false} | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| When set to true, if your router is serving as a floodfill for the network, your floodfill participation will be hidden from other routers. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| router.maxParticipatingTunnels={n} | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Determines the maximum number of participating tunnels the router can build. To disable participation completely, set to 0. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Determines the maximum number of participating tunnels the router can build. +To disable participation completely, set to 0. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| router.networkDatabase.flat={true|false} | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
When set to true, the router info files stored in your profile's netDB directory will not be split into 64 sub-directories.
diff --git a/apps/routerconsole/jsp/help-faq.jsi b/apps/routerconsole/jsp/help-faq.jsi
index 82da347150..082afee143 100644
--- a/apps/routerconsole/jsp/help-faq.jsi
+++ b/apps/routerconsole/jsp/help-faq.jsi
@@ -1,20 +1,29 @@
Abridged I2P FAQ-This is a shortened version of the official FAQ. For the full version, please visit https://geti2p.net/faq or http://i2p-projekt.i2p/faq. + This is a shortened version of the official FAQ. +For the full version, please visit https://geti2p.net/faq or http://i2p-projekt.i2p/faq. My router has been up for several minutes and has zero or very few connections-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 Reseed Configuration page and click the Save Changes and Reseed Now button. +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 Reseed Configuration page and click the "Save Changes and Reseed Now" button. My router has very few active peers, is this OK?-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 share more bandwidth. +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 share more bandwidth. I'm missing lots of hosts in my addressbook. What are some good subscription links?-The default subscription is to The default subscription is to Here are some other public addressbook subscription links. You may wish to add one or two to your susidns subscription list. 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. +Here are some other public addressbook subscription links. +You may wish to add one or two to your susidns subscription list. +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.
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. +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. How do I access IRC, BitTorrent, or other services on the regular Internet?-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 Tor. +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 Tor. How do I configure my browser to access .i2p websites?-You will need to configure your browser to use the HTTP proxy server (by default on host: You will need to configure your browser to use the HTTP proxy server (by default on host: What is an eepsite?-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 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 Most of the eepsites are down?-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. http://identiguy.i2p tracks active eepsites. +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. +http://identiguy.i2p tracks active eepsites. How do I connect to IRC within I2P?-A tunnel to the main IRC server network within I2P, Irc2P, is created when I2P is installed (see the I2P Tunnel Manager), and is automatically started when the I2P router starts. To connect to it, tell your IRC client to connect to server: A tunnel to the main IRC server network within I2P, Irc2P, is created when I2P is installed (see the I2P Tunnel Manager), and is automatically started when the I2P router starts.
+To connect to it, tell your IRC client to connect to server: XChat-like client users can create a new network with the server HexChat-like client users can create a new network with the server What ports does I2P use?
On top of the I2P router are a series of client applications, each with their own set of licenses and dependencies:
For details on other applications available, as well as their licenses, please see the
-license policy. Additional licenses can be found in the For details on other applications available, as well as their licenses, please see the license policy.
+Additional licenses can be found in the Summary Bar Information-Many of the stats on the summary bar may be configured to be graphed for further analysis. You may also customize the sections that appear on the Summary Bar and their positioning on the Summary Bar Configuration page. + Many of the stats on the summary bar may be configured to be graphed for further analysis. +You may also customize the sections that appear on the Summary Bar and their positioning on the Summary Bar Configuration page. Router Info@@ -8,20 +9,34 @@
Bandwidth In/Out-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 Bandwidth Configuration page. 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 SpeedTest 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 graphed by default. +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 Bandwidth Configuration page. +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 SpeedTest 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 graphed by default. Local Destinations-These are the local services provided by your router. They may be clients started through the Tunnel Manager 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… 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 main Tunnel Manager page. +These are the local services provided by your router. +They may be clients started through the Tunnel Manager 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…" 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 main Tunnel Manager page. Tunnels@@ -74,23 +115,37 @@ This is the number of peers your router has available for building your explorat Client: Tunnels built by your router for each client's use.router.maxParticipatingTunnels=nnn on the Advanced configuration page. [Enable graphing].
+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 Bandwidth Configuration page.
+You may also limit the total number by setting router.maxParticipatingTunnels=nnn on the Advanced configuration page.
+[Enable graphing].
Congestion-Note: This section is not enabled by default. You may enable it on the Summary Bar Configuration page. +Note: This section is not enabled by default. +You may enable it on the Summary Bar Configuration page. Some basic indications of router overload:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||