From 4c7f8c1ef173d12a94348f64c599bdef4809babf Mon Sep 17 00:00:00 2001 From: zzz Date: Tue, 28 Jan 2014 15:16:29 +0000 Subject: [PATCH] sort the i2cp options --- i2p2www/pages/site/docs/protocol/i2cp.html | 482 ++++++++++----------- 1 file changed, 241 insertions(+), 241 deletions(-) diff --git a/i2p2www/pages/site/docs/protocol/i2cp.html b/i2p2www/pages/site/docs/protocol/i2cp.html index 842a13c4..ac196f86 100644 --- a/i2p2www/pages/site/docs/protocol/i2cp.html +++ b/i2p2www/pages/site/docs/protocol/i2cp.html @@ -1,7 +1,7 @@ {% extends "global/layout.html" %} {% block title %}I2CP{% endblock %} -{% block lastupdated %}{% trans %}December 2013{% endtrans %}{% endblock %} -{% block accuratefor %}0.9.9{% endblock %} +{% block lastupdated %}{% trans %}January 2014{% endtrans %}{% endblock %} +{% block accuratefor %}0.9.10{% endblock %} {% block content %}

{% trans -%} The I2P Client Protocol (I2CP) exposes a strong separation of concerns between @@ -108,25 +108,151 @@ a SessionConfig contained in a -inbound.quantity -  -{% trans from=1, to=3 %}number from {{ from }} to {{ to }}{% endtrans %} -{% trans from=1, to=16 %}{{ from }} to {{ to }}{% endtrans %} -2 +crypto.lowTagThreshold +0.9.2 +  +1-128 +30 {% trans -%} -Number of tunnels in. -Limit was increased from 6 to 16 in release 0.9; however, numbers higher than 6 are not -currently recommended, as this is untested and is incompatible with older releases. +Minimum number of ElGamal/AES Session Tags before we send more. +Recommended: approximately tagsToSend * 2/3 {%- endtrans %} -outbound.quantity +crypto.tagsToSend +0.9.2 +  +1-128 +40 +{% trans -%} +Number of ElGamal/AES Session Tags to send at a time. +For clients with relatively low bandwidth per-client-pair (IRC, some UDP apps), this may be set lower. +{%- endtrans %} + + + +explicitPeers   -{% trans from=1, to=3 %}number from {{ from }} to {{ to }}{% endtrans %} +  +  +null +{% trans %}Comma-separated list of Base 64 Hashes of peers to build tunnels through; for debugging only{% endtrans %} + + + +i2cp.dontPublishLeaseSet +  +true, false +  +false +{% trans %}Should generally be set to true for clients and false for servers{% endtrans %} + + + +i2cp.fastReceive +0.9.4 +  +true, false +false +{% trans -%} +If true, the router just sends the MessagePayload instead +of sending a MessageStatus and awaiting a ReceiveMessageBegin. +{%- endtrans %} + + + +i2cp.messageReliability +  +  +BestEffort, None +BestEffort +{% trans -%} +Guaranteed is disabled; +None implemented in 0.8.1; the streaming lib default is None as of 0.8.1, the client side default is None as of 0.9.4 +{%- endtrans %} + + + +i2cp.password +0.8.2 +string +  +  +{% trans -%} +For authorization, if required by the router. +If the client is running in the same JVM as a router, this option is not required. +Warning - username and password are sent in the clear to the router, unless using SSL (i2cp.SSL=true). +Authorization is only recommended when using SSL. +{%- endtrans %} + + + +i2cp.username +0.8.2 +string +  +  + + + +inbound.allowZeroHop +  +true, false +  +true +{% trans %}If incoming zero hop tunnel is allowed{% endtrans %} + + + +outbound.allowZeroHop +  +true, false +  +true +{% trans %}If outgoing zero hop tunnel is allowed{% endtrans %} + + + +inbound.backupQuantity +  +{% trans from=0, to=3 %}number from {{ from }} to {{ to }}{% endtrans %} {% trans %}No limit{% endtrans %} +0 +{% trans %}Number of redundant fail-over for tunnels in{% endtrans %} + + + +outbound.backupQuantity +  +{% trans from=0, to=3 %}number from {{ from }} to {{ to }}{% endtrans %} +{% trans %}No limit{% endtrans %} +0 +{% trans %}Number of redundant fail-over for tunnels out{% endtrans %} + + + +inbound.IPRestriction +  +{% trans from=0, to=4 %}number from {{ from }} to {{ to }}{% endtrans %} +{% trans from=0, to=4 %}{{ from }} to {{ to }}{% endtrans %} 2 -{% trans %}Number of tunnels out{% endtrans %} +{% trans -%} +Number of IP bytes to match to determine if +two routers should not be in the same tunnel. 0 to disable. +{%- endtrans %} + + + +outbound.IPRestriction +  +{% trans from=0, to=4 %}number from {{ from }} to {{ to }}{% endtrans %} +{% trans from=0, to=4 %}{{ from }} to {{ to }}{% endtrans %} +2 +{% trans -%} +Number of IP bytes to match to determine if +two routers should not be in the same tunnel. 0 to disable. +{%- endtrans %} @@ -177,24 +303,6 @@ The default variance was 1 prior to release 0.7.6. {%- endtrans %} - -inbound.backupQuantity -  -{% trans from=0, to=3 %}number from {{ from }} to {{ to }}{% endtrans %} -{% trans %}No limit{% endtrans %} -0 -{% trans %}Number of redundant fail-over for tunnels in{% endtrans %} - - - -outbound.backupQuantity -  -{% trans from=0, to=3 %}number from {{ from }} to {{ to }}{% endtrans %} -{% trans %}No limit{% endtrans %} -0 -{% trans %}Number of redundant fail-over for tunnels out{% endtrans %} - - inbound.nickname   @@ -216,48 +324,6 @@ use the first few characters of the Base64 hash of the destination by default. {% trans %}Name of tunnel - generally ignored unless inbound.nickname is unset.{% endtrans %} - -inbound.allowZeroHop -  -true, false -  -true -{% trans %}If incoming zero hop tunnel is allowed{% endtrans %} - - - -outbound.allowZeroHop -  -true, false -  -true -{% trans %}If outgoing zero hop tunnel is allowed{% endtrans %} - - - -inbound.IPRestriction -  -{% trans from=0, to=4 %}number from {{ from }} to {{ to }}{% endtrans %} -{% trans from=0, to=4 %}{{ from }} to {{ to }}{% endtrans %} -2 -{% trans -%} -Number of IP bytes to match to determine if -two routers should not be in the same tunnel. 0 to disable. -{%- endtrans %} - - - -outbound.IPRestriction -  -{% trans from=0, to=4 %}number from {{ from }} to {{ to }}{% endtrans %} -{% trans from=0, to=4 %}{{ from }} to {{ to }}{% endtrans %} -2 -{% trans -%} -Number of IP bytes to match to determine if -two routers should not be in the same tunnel. 0 to disable. -{%- endtrans %} - - outbound.priority 0.9.4 @@ -271,90 +337,48 @@ Higher is higher priority. -i2cp.dontPublishLeaseSet +inbound.quantity   -true, false -  -false -{% trans %}Should generally be set to true for clients and false for servers{% endtrans %} - - - -i2cp.messageReliability -  -  -BestEffort, None -BestEffort +{% trans from=1, to=3 %}number from {{ from }} to {{ to }}{% endtrans %} +{% trans from=1, to=16 %}{{ from }} to {{ to }}{% endtrans %} +2 {% trans -%} -Guaranteed is disabled; -None implemented in 0.8.1; the streaming lib default is None as of 0.8.1, the client side default is None as of 0.9.4 +Number of tunnels in. +Limit was increased from 6 to 16 in release 0.9; however, numbers higher than 6 are not +currently recommended, as this is untested and is incompatible with older releases. {%- endtrans %} -i2cp.fastReceive -0.9.4 -  -true, false -false -{% trans -%} -If true, the router just sends the MessagePayload instead -of sending a MessageStatus and awaiting a ReceiveMessageBegin. -{%- endtrans %} +outbound.quantity +  +{% trans from=1, to=3 %}number from {{ from }} to {{ to }}{% endtrans %} +{% trans %}No limit{% endtrans %} +2 +{% trans %}Number of tunnels out{% endtrans %} -explicitPeers +inbound.*       -null -{% trans %}Comma-separated list of Base 64 Hashes of peers to build tunnels through; for debugging only{% endtrans %} - - - -i2cp.username -0.8.2 -string   -  -{% trans -%} -For authorization, if required by the router. -If the client is running in the same JVM as a router, this option is not required. -Warning - username and password are sent in the clear to the router, unless using SSL (i2cp.SSL=true). -Authorization is only recommended when using SSL. +{% trans -%} +Any other options prefixed with "inbound." are stored +in the "unknown options" properties of the inbound tunnel pool's settings. {%- endtrans %} -i2cp.password -0.8.2 -string +outbound.* +      - - - -crypto.tagsToSend -0.9.2   -1-128 -40 {% trans -%} -Number of ElGamal/AES Session Tags to send at a time. -For clients with relatively low bandwidth per-client-pair (IRC, some UDP apps), this may be set lower. -{%- endtrans %} - - - -crypto.lowTagThreshold -0.9.2 -  -1-128 -30 -{% trans -%} -Minimum number of ElGamal/AES Session Tags before we send more. -Recommended: approximately tagsToSend * 2/3 +Any other options prefixed with "outbound." are stored +in the "unknown options" properties of the outbound tunnel pool's settings. {%- endtrans %} @@ -392,30 +416,6 @@ HTTP servers may fit these requirements. - - -inbound.* -  -  -  -  -{% trans -%} -Any other options prefixed with "inbound." are stored -in the "unknown options" properties of the inbound tunnel pool's settings. -{%- endtrans %} - - - -outbound.* -  -  -  -  -{% trans -%} -Any other options prefixed with "outbound." are stored -in the "unknown options" properties of the outbound tunnel pool's settings. -{%- endtrans %} -

{% trans -%} @@ -451,57 +451,12 @@ Other implementations may have different defaults. -i2cp.tcp.host -  -  -  -127.0.0.1 -{% trans -%} -Router hostname. -If the client is running in the same JVM as a router, this option is ignored, and the client connects to that router internally. -{%- endtrans %} - - - -i2cp.tcp.port -  -  -1-65535 -7654 -{% trans -%} -Router I2CP port. -If the client is running in the same JVM as a router, this option is ignored, and the client connects to that router internally. -{%- endtrans %} - - - -i2cp.SSL -0.8.3 -true, false -  -false -{% trans -%} -Connect to the router using SSL. -If the client is running in the same JVM as a router, this option is ignored, and the client connects to that router internally. -{%- endtrans %} - - - -i2cp.gzip -0.6.5 -true, false -  -true -{% trans %}Gzip outbound data{% endtrans %} - - - -i2cp.reduceOnIdle +i2cp.closeIdleTime 0.7.1 -true, false +1800000 +{% trans num=300000 %}{{ num }} minimum{% endtrans %}   -false -{% trans %}Reduce tunnel quantity when idle{% endtrans %} +{% trans %}(ms) Idle time required (default 30 minutes){% endtrans %} @@ -513,33 +468,6 @@ If the client is running in the same JVM as a router, this option is ignored, an {% trans %}Close I2P session when idle{% endtrans %} - -i2cp.reduceIdleTime -0.7.1 -1200000 -{% trans num=300000 %}{{ num }} minimum{% endtrans %} -  -{% trans %}(ms) Idle time required (default 20 minutes, minimum 5 minutes){% endtrans %} - - - -i2cp.closeIdleTime -0.7.1 -1800000 -{% trans num=300000 %}{{ num }} minimum{% endtrans %} -  -{% trans %}(ms) Idle time required (default 30 minutes){% endtrans %} - - - -i2cp.reduceQuantity -0.7.1 -1 -{% trans from=1, to=5 %}{{ from }} to {{ to }}{% endtrans %} -1 -{% trans %}Tunnel quantity when reduced (applies to both inbound and outbound){% endtrans %} - - i2cp.encryptLeaseSet 0.7.1 @@ -549,6 +477,27 @@ If the client is running in the same JVM as a router, this option is ignored, an {% trans %}Encrypt the lease{% endtrans %} + +i2cp.fastReceive +0.9.4 +  +true, false +true +{% trans -%} +If true, the router just sends the MessagePayload instead +of sending a MessageStatus and awaiting a ReceiveMessageBegin. +{%- endtrans %} + + + +i2cp.gzip +0.6.5 +true, false +  +true +{% trans %}Gzip outbound data{% endtrans %} + + i2cp.leaseSetKey 0.7.1 @@ -571,14 +520,65 @@ None implemented in 0.8.1; None is the default as of 0.9.4 -i2cp.fastReceive -0.9.4 +i2cp.reduceIdleTime +0.7.1 +1200000 +{% trans num=300000 %}{{ num }} minimum{% endtrans %}   +{% trans %}(ms) Idle time required (default 20 minutes, minimum 5 minutes){% endtrans %} + + + +i2cp.reduceOnIdle +0.7.1 true, false -true +  +false +{% trans %}Reduce tunnel quantity when idle{% endtrans %} + + + +i2cp.reduceQuantity +0.7.1 +1 +{% trans from=1, to=5 %}{{ from }} to {{ to }}{% endtrans %} +1 +{% trans %}Tunnel quantity when reduced (applies to both inbound and outbound){% endtrans %} + + + +i2cp.SSL +0.8.3 +true, false +  +false {% trans -%} -If true, the router just sends the MessagePayload instead -of sending a MessageStatus and awaiting a ReceiveMessageBegin. +Connect to the router using SSL. +If the client is running in the same JVM as a router, this option is ignored, and the client connects to that router internally. +{%- endtrans %} + + + +i2cp.tcp.host +  +  +  +127.0.0.1 +{% trans -%} +Router hostname. +If the client is running in the same JVM as a router, this option is ignored, and the client connects to that router internally. +{%- endtrans %} + + + +i2cp.tcp.port +  +  +1-65535 +7654 +{% trans -%} +Router I2CP port. +If the client is running in the same JVM as a router, this option is ignored, and the client connects to that router internally. {%- endtrans %}