new config file spec

www.i2p2/pages/configuration.html

@@ -0,0 +1,105 @@
+{% extends "_layout.html" %}
+{% block title %}Configuration File Specification{% endblock %}
+{% block content %}
+Updated September 2012, current as of router version 0.9.2
+
+
+<h2>Overview</h2>
+<p>
+This page provides a general specification of I2P configuration files,
+used by the router and various applications.
+It also gives an overview of the information contained in the various files,
+and links to detailed documentation where available.
+</p>
+
+
+<h2>General Format</h2>
+<p>
+An I2P configuration file is formatted as specified in
+<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Properties.html#load%28java.io.InputStream%29">Java Properties</a>
+with the following exceptions:
+<ul>
+<li>Encoding must be UTF-8
+<li>Does not use or recognize any escapes, including '\', so lines may not be continued
+<li>'#' or ';' starts a comment, but '!' does not
+<li>'#' starts a comment in any position but ';' must be in column 1 to start a comment
+<li>Leading and trailing whitespace is not trimmed on keys
+<li>Leading and trailing whitespace is trimmed on values
+<li>'=' is the only key-termination character (not ':' or whitespace)
+<li>Lines without '=' are ignored. It does not store the key with a value of ""
+<li>As there are no escapes,
+    keys may not contain '#', '=', or '\n', or start with ';'
+<li>As there are no escapes,
+    values may not contain '#' or '\n', or start or end with '\r' or whitespace
+</ul>
+</p><p>
+The file need not be sorted, but most applications do sort by key when
+writing to the file, for ease of reading and manual editing.
+</p><p>
+Reads and writes are implemented in
+<a href="http://docs.i2p-projekt.de/javadoc/net/i2p/data/DataHelper.html">DataHelper loadProps() and storeProps()</a>.
+Note that the file format is significantly different than the
+serialized format for I2P protocols specified in
+<a href="common_structures_spec#type_Mapping">Mapping</a>.
+</p>
+
+<h2>Core library and router</h2>
+
+<h3>Clients (clients.config)</h3>
+<p>
+Configured via /configclients in the router console.
+</p>
+
+<h3>Logger (logger.config)</h3>
+<p>
+Configured via /configlogging in the router console.
+</p>
+
+<h3>Individual Plugin (xxx/plugin.config)</h3>
+<p>
+See <a href="plugin_spec.html">the plugin specification</a>.
+</p>
+
+<h3>Plugins (plugins.config)</h3>
+<p>
+Enable/disable for each installed plugin..
+</p>
+
+<h3>Router (router.config)</h3>
+<p>
+Configured via /configadvanced in the router console.
+</p>
+
+<h2>Applications</h2>
+
+<h3>Addressbook (addressbook/config.txt)</h3>
+<p>
+See documentation in SusiDNS.
+</p>
+
+<h3>I2PSnark (i2psnark.config)</h3>
+<p>
+Configured via the application gui.
+</p>
+
+<h3>I2PTunnel (i2ptunnel.config)</h3>
+<p>
+Configured via the /i2ptunnel application in the router console.
+</p>
+
+<h3>Router Console</h3>
+<p>
+The router console uses the router.config file.
+</p>
+
+<h3>SusiMail (susimail.config)</h3>
+<p>
+See post on zzz.i2p.
+</p>
+
+<h3>Systray (systray.config)</h3>
+<p>
+TBD
+</p>
+
+{% endblock %}

www.i2p2/pages/how.html

@@ -39,6 +39,7 @@ If you find any inaccuracies in the documents linked below, please
 <li><a href="bittorrent.html">Bittorrent over I2P</a></li>
 <li><a href="i2pcontrol.html">I2PControl Plugin API</a></li>
 <li><a href="blockfile.html">hostsdb.blockfile Format</a></li>
+<li><a href="configuration.html">Configuration File Format</a></li>
 </ul>
 
 <h3>Application Layer API and Protocols</h3>
@@ -172,6 +173,8 @@ The protocols for direct (point-to-point) router to router communication.
 Time synchronization and NTP
 </li><li>
 <a href="performance.html">Performance</a> (not current)
+</li><li>
+<a href="configuration.html">Configuration File Format</a></li>
 </li></ul>
 
 <h3>Developer's Guides and Resources</h3>