source: apps/routerconsole/jsp/help-advancedsettings.jsi @ 46ac0087

Last change on this file since 46ac0087 was 46ac0087, checked in by slumlord <slumlord@…>, 23 months ago

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

  • Property mode set to 100644
File size: 4.8 KB
Line 
1<h2>Advanced Router Configuration</h2>
2
3<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.
4This is not a comprehensive list.
5Some settings will require a restart of the router to take effect.
6Note that all settings are case sensitive.
7You 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>
8
9<table id="configinfo"> <!-- sections separated for legibility -->
10
11<tr><th>i2p.vmCommSystem={true|false}</th></tr>
12<tr><td>When set to true, I2P runs without network connectivity, which is helpful if you are constantly restarting the router to test code updates as this prevents network disruption.</td></tr>
13
14<tr><th>routerconsole.advanced={true|false}</th></tr>
15<tr><td class="infowarn">Only set this to true if you know what you are doing!</td></tr>
16<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>.
17Extra 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>.
18This will also enable the installation of unsigned updates, manual configuration of the news URL, and the installation of plugins.
19You may also wish to enable the "Advanced" sidebar section on the <a href="/configsidebar">Summary Bar Configuration page</a>.</td></tr>
20
21<tr><th>routerconsole.browser={/path/to/browser}</th></tr>
22<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>
23
24<tr><th>router.updateUnsigned={true|false}</th></tr>
25<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>
26
27<tr><th>router.updateUnsignedURL={url}</th></tr>
28<tr><td>This setting allows you to configure the update url for the unsigned update feature, if enabled.
29The url should end with <code>/i2pupdate.zip</code>.
30Note: do not install unsigned updates unless you trust the source of the update!</td></tr>
31
32<tr><th>routerconsole.enablePluginInstall={true|false}</th></tr>
33<tr><td>When set to true, this enables plugin installation on the <a href="/configplugins">Plugin Configuration page</a>.
34Setting <code>routerconsole.advanced=true</code> will also enable this feature.
35[Enabled by default]</td></tr>
36
37<tr><th>routerconsole.allowUntrustedPlugins={true|false}</th></tr>
38<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.
39Note 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>
40
41<tr><th>routerconsole.showSearch={true|false}</th></tr>
42<tr><td>When set to true, a configurable search bar will appear on the <a href="/home">console homepage</a>.
43Additional searches may then be added on the <a href="/confighome">home configuration page</a>.</td></tr>
44
45<tr><th>router.buildHandlerThreads={n}</th></tr>
46<tr><td>Allocate number of processor threads for building tunnels.
47If 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.
48Note that you may wish to allocate less than the theoretical maximum to ensure you have headroom for other tasks.</td></tr>
49
50<tr><th>router.hideFloodfillParticipant={true|false}</th></tr>
51<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>
52
53<tr><th>router.maxParticipatingTunnels={n}</th></tr>
54<tr><td>Determines the maximum number of participating tunnels the router can build.
55To disable participation completely, set to 0.</td></tr>
56
57<tr><th>router.networkDatabase.flat={true|false}</th></tr>
58<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.
59
60</table>
Note: See TracBrowser for help on using the repository browser.