source: installer/resources/readme/readme.html @ 8d629de2

Last change on this file since 8d629de2 was 8d629de2, checked in by zzz <zzz@…>, 3 years ago

readme edits

  • Property mode set to 100644
File size: 16.6 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.
8If not, see the troubleshooting section <a href="#trouble">below</a>.
9These <i>Local Tunnels</i> provide connections to the I2P network, enabling your bittorrent, email, web proxy and other services.
10Your <a href="/netdb">Network Database</a> indicates all known peers on the network.
11Additionally, you can monitor existing <a href="/peers">Peer Connections</a>, and view existing <a href="/tunnels">Tunnels</a> and their status.
12More information is available on the <a href="/help">help page</a>.</li>
13
14<li><b>Network Integration</b><br>
15When you start I2P, it may take a few minutes to bootstrap (integrate) your router into the network and find additional peers, so please be patient.
16When I2P starts up, and during normal operation, I2P's tunnel build readiness indicator in the side panel may indicate that I2P is "Rejecting Tunnels"; this is normal behavior.
17Once 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>
18
19</ul>
20
21<h3>Services on I2P</h3>
22
23<ul class="links">
24
25<li><b>Hidden Services and Public Web Browsing</b><br>
26On I2P you can access hidden service websites ("eepsites") and other services, and you can host your own services.
27You can also access the normal web anonymously via I2P's built-in web proxy (outproxy).
28<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.
29If 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>.
30In the "Sites of Interest" section <a href="#eepsites">below</a>, we list a few of the sites hosted on I2P.</li>
31
32<li><b>Anonymous Email</b><br>
33Postman's I2P-based mail system can be accessed either via <a href="/webmail">I2P's built-in mail client</a> or with any external mail client.
34Accounts can send and receive mail from the normal internet.
35For an account, visit <a href="http://hq.postman.i2p/" target="_blank">hq.postman.i2p</a>.
36Additionally, <a href="http://bote.i2p/" target="_blank">I2P-Bote</a> is an I2P-internal, serverless, secure (end-to-end encrypted) email system with an integrated anonymous/pseudonymous remailer, providing a web interface and a built-in addressbook.
37It can be installed as a <a href="#plugins">plugin</a>.</li>
38
39<li><b>Anonymous File Transfer</b><br>
40<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.
41
42<li><b>Anonymous Chat</b><br>
43Start your IRC client (e.g. HexChat) and connect to the <a href="irc://127.0.0.1:6668/i2p">server</a> at <code>127.0.0.1 port 6668</code>.
44You 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).
45Your 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.
46Once 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.
47There'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.
48And of course you may 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.
49We also provide full access to the <a href="http://docs.i2p-projekt.de/javadoc/" target="_blank">Java API</a>.</li>
50
51<li><b>Forums and Blogging</b><br>
52All 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!
53Also, there are quite a few community run forums on I2P in various languages; see <a href="#eepsites">below</a> for some suggestions.</li>
54
55<li><a name="plugins"></a><b>Plugins for I2P</b><br>
56Extend 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>!
57Browse the plugins and related info at <a href="http://i2pwiki.i2p/index.php?title=Plugins" target="_blank">i2pwiki.i2p</a>.
58If 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>
59
60</ul>
61
62<h3>Anonymous Encrypted Web Hosting on I2P</h3>
63
64<ul class="links">
65
66<li><b>Built-in Web-Server</b><br>
67I2P comes with a built-in 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>.
68To 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.
69You can also run any alternative web server platform over I2P and replace the built-in server, or run it on another tunnel.</li>
70
71<li><b>Start Your Tunnel</b><br>
72After starting up, your pre-configured <a href="/i2ptunnel/" target="_blank">I2P Webserver Tunnel</a>, your website will be visible (but not discoverable) to others.
73Detailed 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>
74
75</ul>
76
77<a name="eepsites"></a>
78<h3>I2P-Hidden Services of Interest</h3>
79
80<ul class="links twocol">
81
82<li><b>Invisible Internet Project (I2P) Official Website</b><br>
83<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>
84
85<li><b>I2P Community Forums</b><br>
86<a href="http://zzz.i2p/" target="_blank">zzz's developer forums</a> hosts discussion related to I2P development.
87
88<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>
89
90<li><b>I2P Anonymous Pastebin</b><br>
91<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>
92
93<li><b>Echelon's I2P Resources</b><br>
94<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>
95
96<li><b>i2pwiki Wiki</b><br>
97<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>
98
99<li><b>The Planet (on I2P)</b><br>
100<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>
101
102<li><b>I2P Network Health</b><br>
103<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>
104
105<li><b>I2P Bug Tracker - Trac</b><br>
106  <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>
107
108<li><b>Discover I2P</b><br>
109There are many more hidden services - just follow the links from the ones you see, bookmark your favourites, and visit them often!<br></li>
110
111</ul>
112
113<h2 id="trouble">Troubleshooting and Further Assistance</h2>
114
115<ul class="links">
116
117<li><b>Be Patient!</b><br>
118I2P may be slow to integrate into network the first time you run it as it bootstraps into the network and finds peers.
119The 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!
120If, 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>
121
122<li><b>Check Your Configuration and Bandwidth Allocation</b><br>
123I2P functions best when you can accurately reflect the speed of your network connection in the <a href="/config">bandwidth configuration section</a>.
124By 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.
125The more bandwidth you allocate, <i>specifically</i> upstream bandwidth, the more you will benefit from the network.</li>
126
127<li><b>Firewalls, Modems and Routers</b><br>
128Where possible, please ensure I2P/Java is allowed un-firewalled access from the internet by configuring your modem/router/pc firewall accordingly.
129If 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".
130For 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>
131
132<li><b>Check Your Proxy Setttings</b><br>
133If 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>.
134If 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>
135
136<li><b>Check Your Logs</b><br>
137<a href="/logs">Logs</a> may help resolve a problem.
138You 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>
139
140<li><b>Verify Java is Up to Date</b><br>
141Ensure your Java is up to date [version 1.7 or higher is required].
142Check 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>.
143If 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>
144
145<li><b>Problems running on Legacy Hardware</b><br>
146[Linux/BSD] If you can't start the router with <code>i2p/i2prouter start</code> try the <code>runplain.sh</code> script in the same directory.
147Root privileges are usually not required to run I2P.
148If 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>
149
150<li><b>Enable Universal Plug and Play (UPnP)</b><br>
151Your modem or router probably supports UPnP for automatic port forwarding.
152Ensure UPnP support is enabled on your modem or router.
153Now try restarting the <a href="/">I2P router</a>.
154If successful, I2P should report "Network: OK" in the side panel once the I2P router completes initial connectivity tests.</li>
155
156<li><b>Port Forwarding</b><br>
157Open <a href="/confignet">I2P's port</a> on your modem, router and/or firewall(s) for better connectivity (ideally both UDP and TCP).
158More 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.
159Note 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>
160
161<li><b>Getting Support Online</b><br>
162You 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.
163These channels are also available outside of I2P's encrypted, anonymous network via <a href="irc://irc.freenode.net/i2p">Freenode IRC</a>.</li>
164
165<li><b>Reporting Bugs</b><br>
166To 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>.
167For 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.
168Developers can browse source at <a href="https://github.com/i2p/i2p.i2p" target="_blank">Github</a>.
169We 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>
170
171<li><b>Get Involved!</b><br>
172I2P is developed and maintained mostly through unfunded, voluntary participation by community members.
173We're happy to accept <a href="http://i2p-projekt.i2p/donate.html" target="_blank">donations</a>, which go into essential hosting and administrative costs.
174We 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.
175The 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.
176For 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>
177
178</ul>
179
180<div class="topness"><a href="#top">[Return to Top]</a></div>
181</div>
Note: See TracBrowser for help on using the repository browser.