source: installer/resources/readme/readme.html @ 7121e3e5

Last change on this file since 7121e3e5 was 7121e3e5, checked in by slumlord <slumlord@…>, 3 years ago

#2239 - Updating readme.html, work in progress.

  • Property mode set to 100644
File size: 18.3 KB
Line 
1<div lang="en">
2
3<ul class="links">
4
5<li><b>Starting Up</b><br>
6If you've just started I2P, the number of <i>Active Peers</i> indicated under the <i>Peers</i> section in the side panel on the left should start to grow over the next few minutes.
7You'll also see a <i>Local Tunnel</i> named <i>Shared Clients</i> listed there, and possibly other clients and servers depending on how I2P is configured (if not, see the troubleshooting section <a href="#trouble">below</a>).
8These <i>Local Tunnels</i> provide connections on different ports (and sometimes protocols) to the I2P network, enabling your bittorrent, e-mail, web proxy and other services to function.
9Your <a href="/netdb">Network Database</a> indicates all known peers on the network.
10Additionally, you can monitor existing <a href="/peers">Peer Connections</a>, and view existing <a href="/tunnels">Tunnels</a> and their status.
11More information is available on the <a href="/help">help page</a>.</li>
12
13<li><b>Network Integration</b><br>
14The first time you start I2P, it may take a few minutes to bootstrap (integrate) your router into the network and find additional peers to optimize your integration, so please be patient.
15When I2P starts up, and during normal operation, I2P's tunnel build readiness indicator (immediately above the <i>Local Tunnels</i> section in the sidepanel) may tell you that I2P is "Rejecting Tunnels"; this is normal behavior and should be no cause for concern!
16Once green stars are indicated next to your <i>Local Tunnels</i>, there is a wide variety of things you can do with I2P, and below we introduce you to some of them.</li>
17
18</ul>
19
20<h3>Services on I2P</h3>
21
22<ul class="links">
23
24<li><b>Invisible Internet &amp; Public Web Browsing</b><br>
25On I2P you can access hidden service websites ("eepsites") and other services (e.g. ssh over I2P, IRC, Jabber etc.) in addition to being able to host your own services.
26You can also access the normal web anonymously via I2P's built-in web proxy (outproxy).
27<a href="https://geti2p.net/en/about/browser-config" target="_blank">Configure your browser</a> to use the HTTP proxy at <code>127.0.0.1 port 4444</code>, then browse to a hidden service website or a normal, unencrypted <code>http://</code> address.
28If you wish to disable or change outproxy access to the normal internet, remove or modify the outproxy entry for <code>false.i2p</code> under the <i>Outproxies</i> option in the <a href="/i2ptunnel/edit?tunnel=0" target="_blank">I2P HTTP Proxy Tunnel Editor</a>.
29In the "Sites of Interest" section <a href="#eepsites">below</a>, we list a few of the sites hosted on I2P.</li>
30
31<li><b>Anonymous E-Mail</b><br>
32Postman's I2P-based mail system can be accessed either via <a href="/webmail">I2P's built-in mail client</a> (susimail) or using any mail client that supports smtp and pop3.
33Accounts can send and receive mail from the normal internet.
34For an account, visit <a href="http://hq.postman.i2p/" target="_blank">hq.postman.i2p</a>.
35Additionally, <a href="http://bote.i2p/" target="_blank">I2P-Bote</a> is an I2P-internal, serverless, secure (end-to-end encrypted) e-mail system with an integrated anonymous/pseudonymous remailer, providing a web interface and a built-in addressbook.
36It was originally created by HungryHobo and is now being actively developed by str4d; it can be installed as a <a href="#plugins">plugin</a>.</li>
37
38<li><b>Anonymous File Transfer</b><br>
39<a href="/torrents">I2PSnark</a> is integrated into I2P, providing anonymous, encrypted <a href="https://secure.wikimedia.org/wikipedia/en/wiki/BitTorrent_%28protocol%29" target="_blank">BitTorrent</a> transfers.
40In addition, Sponge develops a bittorrent client called <a href="http://bob.i2p/Robert.html">Robert</a> written in Python.
41There is also a port of <a href="http://www.emule-project.net/" target="_blank">eMule</a> to I2P called <a href="http://echelon.i2p/imule/">iMule</a> [Needs developers!], an anonymous, secure implementation of a <a href="https://secure.wikimedia.org/wikipedia/en/wiki/Gnutella" target="_blank">Gnutella network</a>, accessible using <a href="http://echelon.i2p/i2phex/" target="_blank">I2Phex</a> [maintained by Complication, seeking new developers!], and additional facilities including browser-based file hosting.</li>
42
43<li><b>Anonymous Chat</b><br>
44Start your IRC client (e.g. HexChat, Weechat, etc.) and connect to the <a href="irc://127.0.0.1:6668/i2p">server</a> at <code>127.0.0.1 port 6668</code>.
45You do not need to configure a proxy in your IRC client; I2P provides you with a local IRC tunnel (configured in your IRC client as an IRC server or remote host).
46Your local I2P IRC tunnel on <code>localhost:6668</code> will direct you to one of three IRC servers hosted on I2P by Postman, echelon and zl0, but neither you nor they know where the other is, and your communcations are encrypted in transit by I2P to prevent interception.
47Once you're there, <code>#i2p-chat</code> and <code>#i2p-dev</code> are just a few of the available channels you may wish to join.
48There's also an I2P-based <a href="http://echelon.i2p/qti2pmessenger/">Instant Messenger</a> for unmonitorable and uncensorable anonymous chat, as well as alternative IRC servers, Jabber servers, website-based chat, and more.
49And of course you're entirely free to run your own servers over I2P in whatever flavor you choose, or if you're a developer write your own <a href="http://i2p-projekt.i2p/applications.html" target="_blank">I2P applications</a> (both <a href="https://secure.wikimedia.org/wikipedia/en/wiki/User_Datagram_Protocol" target="_blank">UDP</a> and <a href="https://secure.wikimedia.org/wikipedia/en/wiki/Transmission_Control_Protocol" target="_blank">TCP</a> protocols are <a href="http://i2p-projekt.i2p/techintro.html#op.transport" target="_blank">provisioned</a>), and <a href="http://i2p-projekt.i2p/streaming.html" target="_blank">realtime streaming</a> is also possible.
50We also provide full access to the <a href="http://docs.i2p-projekt.de/javadoc/" target="_blank">Java API</a>.</li>
51
52<li><b>Forums &amp; Blogging</b><br>
53If you're looking to run your own blog or forum, you might be interested in <a href="http://syndie-project.i2p/" target="_blank">Syndie</a>, a distributed forum and blogging platform for I2P [Needs developers!].
54And, of course, all normal blogging, forum and cms software will run over I2P, though you're advised to take extra precautions with security when setting up and to keep all associated software (e.g. Php, MySql, Python, Apache) up to date and locked-down!
55Also, there are quite a few community run forums on I2P in various languages; see <a href="#eepsites">below</a> for some suggestions.</li>
56
57<li><a name="plugins"></a><b>Plugins for I2P</b><br>
58Extend the usefulness of I2P by installing plugins: blogging, chatting, file sharing and other plugins have already been written or ported and await your <a href="http://i2pwiki.i2p/index.php?title=Plugins" target="_blank">installation</a>!
59Browse the plugins and related info at <a href="http://i2pwiki.i2p/index.php?title=Plugins" target="_blank">i2pwiki.i2p</a>.
60If you're a <a href="http://i2pwiki.i2p/index.php?title=Plugins" target="_blank">developer</a>, a complete language-agnostic framework for writing your own plugins is provided with <a href="http://i2p-projekt.i2p/plugins.html" target="_blank">documentation</a>; I2P plugins can be coded in any language.</li>
61
62</ul>
63
64<h3>Anonymous Encrypted Web Hosting on I2P</h3>
65
66<ul class="links">
67
68<li><b>Built-in Web-Server</b><br>
69I2P comes with a built-in, ready-to-go web server for hosting your own hidden service website ("eepsite") on the I2P network: a <a href="https://www.eclipse.org/jetty/" target="_blank">Jetty</a> instance listening on <a href="http://127.0.0.1:7658/" target="_blank">http://127.0.0.1:7658/</a>.
70To host your own content, simply place your files in the <code>eepsite/docroot/</code> directory (or place any standard JSP/Servlet .war files under <code>eepsite/webapps</code>, or standard CGI scripts under <code>eepsite/cgi-bin</code>) and they'll show up.
71You can also run any alternative web server platform over I2P and replace the built-in server, or run it on another tunnel.</li>
72
73<li><b>Start Your Tunnel</b><br>
74After starting up, your pre-configured <a href="/i2ptunnel/" target="_blank">I2P Webserver Tunnel</a>, your website will be visible (but not discoverable) to others.
75Detailed instructions for starting your website, registering an .i2p domain and promoting your site to others are accessible via your own I2P webserver on <a href="http://127.0.0.1:7658/help/" target="_blank">http://127.0.0.1:7658/help/</a>.</li>
76
77</ul>
78
79<a name="eepsites"></a>
80<h3>I2P-Hidden Services of Interest</h3>
81
82<ul class="links twocol">
83
84<li><b>Invisible Internet Project (I2P) Official Website</b><br>
85<a href="http://i2p-projekt.i2p" target="_blank">i2p-projekt.i2p</a>: Secure and anonymous connections to <a href="https://geti2p.net/en/" target="_blank">geti2p.net</a>. If you want to know more about how I2P works or how you can participate, this is the first place to visit!</li>
86
87<li><b>I2P Community Forums</b><br>
88<a href="http://zzz.i2p/" target="_blank">zzz's developer forums</a> hosts discussion related to I2P development.
89
90<a href="http://i2pforum.i2p/" target="_blank">i2pforum.i2p</a>: A secure and anonymous connection to an online forum community where problems and ideas relating to I2P and associated topics are discussed.</li>
91
92<li><b>I2P Anonymous Pastebin</b><br>
93<a href="http://zerobin.i2p/" target="_blank">zerobin.i2p</a>: Secure and anonymous paste service allowing anonymous text and text-based code sharing over I2P.</li>
94
95<li><b>Echelon's I2P Resources</b><br>
96<a href="http://echelon.i2p/" target="_blank">echelon.i2p</a>: I2P software archive with source code (where permissible), information about I2P, including a <a href="http://echelon.i2p/I2Pguide/index.html" target="_blank">beginner's guide</a> and pre-release developer builds of I2P for the adventurous to try.</li>
97
98<li><b>i2pwiki Wiki</b><br>
99<a href="http://i2pwiki.i2p/" target="_blank">i2pwiki.i2p</a>: An open wiki that anyone can edit with plenty of information about I2P, help for beginners, additional links into the network, and more.</li>
100
101<li><b>The Planet (on I2P)</b><br>
102<a href="http://planet.i2p/" target="_blank">planet.i2p</a>: An RSS aggregator site that takes news and events from around I2P and publishes them all in one place. A good site to visit to see the community at work!</li>
103
104<li><b>I2P Network Health</b><br>
105<a href="http://stats.i2p/cgi-bin/dashboard.cgi" target="_blank">stats.i2p</a>: Check out various aspects of network performance with this I2P network monitoring site run by zzz.</li>
106
107<li><b>I2P Bug Tracker - Trac</b><br>
108  <a href="http://trac.i2p2.i2p/" target="_blank">trac.i2p2.i2p</a>: I2P's issue reporting and bug-tracking system. Please visit if you have an issue to report, also available at <a href="https://trac.i2p2.de/" target="_blank">https://trac.i2p2.de/</a></li>
109
110<li><b>Discover I2P</b><br>
111There are many more hidden services - just follow the links from the ones you see, bookmark your favourites, and visit them often!<br></li>
112
113</ul>
114
115<h2 id="trouble">Troubleshooting &amp; Further Assistance</h2>
116
117<ul class="links">
118
119<li><b>Be Patient!</b><br>
120I2P may be slow to integrate into network the first time you run it as it bootstraps into the network and learns of additional peers.
121The longer your I2P router is running, the better it will perform, so try and keep your router on as long as you can, 24/7 if possible!
122If, after 30 minutes, your <i>Active: [connected/recent]</i> count still has less than 10 peers, or your total number of <i>Integrated</i> peers is less than 5, there are several things you can do to check for problems:</li>
123
124<li><b>Check Your Configuration &amp; Bandwidth Allocation</b><br>
125I2P functions best when you can accurately reflect the speed of your network connection in the <a href="/config">bandwidth configuration section</a>.
126By default I2P is configured with some fairly conservative values that will not suit many use cases, so please take time to review these settings and correct where necessary.
127The more bandwidth you allocate, <i>specifically</i> upstream bandwidth, the more you will benefit from the network.</li>
128
129<li><b>Firewalls, Modems &amp; Routers</b><br>
130Where possible, please ensure I2P/Java is allowed un-firewalled access from the internet by configuring your modem/router/pc firewall accordingly.
131If you're behind a prohibitive firewall but have unrestricted outbound access, I2P can still function; you can turn off inbound access and rely on <a href="http://i2p-projekt.i2p/udp.html" target="_blank">SSU IP Address Detection</a> (<a href="https://secure.wikimedia.org/wikipedia/en/wiki/Hole_punching" target="_blank">firewall hole punching</a>) to connect you to the network, and your network status in the side panel will indicate "Network: Firewalled".
132For optimal performance, where possible please ensure I2P's <a href="/confignet">external port</a> is visible from the internet (see below for more information).</li>
133
134<li><b>Check Your Proxy Setttings</b><br>
135If you cannot see any websites at all (not even <a href="http://i2p-projekt.i2p/" target="_blank">i2p-projekt.i2p</a>), make sure your browser's proxy is set to access http traffic (<i>not</i> https, <i>not</i> socks) via <code>127.0.0.1 port 4444</code>.
136If you need some help, there's <a href="https://geti2p.net/en/about/browser-config" target="_blank">a guide</a> to configuring your browser for I2P use.</li>
137
138<li><b>Check Your Logs</b><br>
139<a href="/logs">Logs</a> may help resolve a problem.
140You may wish to paste excerpts in our <a href="http://i2pforum.i2p/" target="_blank">forum</a> for help, or perhaps <a href="http://zerobin.i2p/" target="_blank">paste</a> it instead and reference the link on IRC for help.</li>
141
142<li><b>Verify Java is Up to Date</b><br>
143Ensure your Java is up to date [version 1.7 or higher is required].
144Check the version of your JRE (<a href="https://secure.wikimedia.org/wikipedia/en/wiki/JRE" target="_blank">Java Runtime Environment</a>) at the top of <a href="/logs">the logs page</a>.
145If you're a developer, a <a href="https://secure.wikimedia.org/wikipedia/en/wiki/Java_SDK" target="_blank">Java SDK</a> and <a href="http://ant.apache.org/" target="_blank">Apache Ant</a> are required to build from source. </li>
146
147<li><b>Problems running on Legacy Hardware</b><br>
148[Linux/Unix/Solaris] If you can't start the router with <code>i2p/i2prouter start</code> try the <code>runplain.sh</code> script in the same directory.
149Root privileges are usually not required to run I2P.
150If you need to compile the <a href="http://i2p-projekt.i2p/jbigi.html" target="_blank">jBigi library</a> (which is necessary in rare cases), consult appropriate documentation, visit the forums, or come pay a visit to our <a href="irc://127.0.0.1:6668/i2p-dev">IRC developer channel</a>.</li>
151
152<li><b>Enable Universal Plug and Play (UPnP)</b><br>
153Your modem or router may support <a href="https://secure.wikimedia.org/wikipedia/en/wiki/Universal_Plug_and_Play" target="_blank">Universal Plug &amp; Play</a> (UPnP), which permits automatic port forwarding.
154Ensure UPnP support for I2P is enabled on the <a href="/confignet">config page</a>, then try to activate UPnP on your modem/router and possibly your computer also.
155Now try restarting the <a href="/">I2P router</a>.
156If successful, I2P should report "Network: OK" in the side panel once the I2P router completes initial connectivity tests.</li>
157
158<li><b>Port Forwarding</b><br>
159Open <a href="/confignet">I2P's port</a> on your modem, router and/or firewall(s) for better connectivity (ideally both UDP and TCP).
160More information on how to go about port forwarding can be found at <a href="TODO" target="_blank">TODO</a>, in addition to our forums and IRC channels listed below.
161Note that I2P does not support connecting to the internet via an http or socks proxy [patches welcome!], though you can connect to proxies via I2P itself once connected to the network.</li>
162
163<li><b>Getting Support Online</b><br>
164You may also want to review the information on the <a href="http://i2p-projekt.i2p/" target="_blank">I2P website</a>, post messages to the <a href="http://forums.i2p/" target="_blank">I2P discussion forum</a> or swing by <a href="irc://127.0.0.1:6668/i2p">#i2p</a> or <a href="irc://127.0.0.1:6668/i2p-chat">#i2p-chat</a> on I2P's internal IRC network - Irc2P.
165These channels are also available outside of I2P's encrypted, anonymous network via <a href="irc://irc.freenode.net/i2p">Freenode IRC</a>.</li>
166
167<li><b>Reporting Bugs</b><br>
168If you'd like to report a bug, please file a ticket on <a href="http://trac.i2p2.i2p/" target="_blank">trac.i2p2.i2p</a> or, over clearnet, <a href="https://trac.i2p2.de/" target="_blank">https://trac.i2p2.de/</a>.
169For developer-related discussions, please visit <a href="http://zzz.i2p/" target="_blank">zzz's developer forums</a> or come and visit the <a href="irc://127.0.0.1:6668/i2p-dev">developer channel</a> on I2P's IRC network.
170Developers can browse source at <a href="https://github.com/i2p/i2p.i2p" target="_blank">Github</a>.
171We use <a href="http://i2p-projekt.i2p/monotone.html" target="_blank">monotone</a> to manage our source code - while you may clone the source code anonymously, commits are accepted only after accepting the developer agreement.</li>
172
173<li><b>Get Involved!</b><br>
174I2P is developed and maintained mostly through unfunded, voluntary participation by community members.
175We're happy to accept <a href="http://i2p-projekt.i2p/donate.html" target="_blank">donations</a>, which go into essential hosting and administrative costs.
176We have <a href="http://i2p-projekt.i2p/bounties.html" target="_blank">cash bounties</a> for aspects of I2P for developers looking for incentives to participate, and we're always looking for more <a href="http://i2p-projekt.i2p/newdevelopers.html" target="_blank">Java coders</a>, <a href="http://i2p-projekt.i2p/newtranslators.html" target="_blank">translators</a>, promoters and users to help I2P grow.
177The bigger the I2P network, the more everyone benefits, so simply telling all your friends about I2P (and lending a hand with the installation and setup where needed) is helpful.
178For further info on how you can participate, visit the <a href="http://i2p-projekt.i2p/getinvolved.html" target="_blank">volunteers page</a> on the website.</li>
179
180</ul>
181
182<div class="topness"><a href="#top">[Return to Top]</a></div>
183<div class="footnote"><hr>Document updated: August 2018</div>
184</div>
Note: See TracBrowser for help on using the repository browser.