Changeset 8d629de2 for installer


Ignore:
Timestamp:
Aug 2, 2018 8:50:18 PM (20 months ago)
Author:
zzz <zzz@…>
Branches:
master
Children:
526aadb
Parents:
8fb7bd2
Message:

readme edits

File:
1 edited

Legend:

Unmodified
Added
Removed
  • installer/resources/readme/readme.html

    r8fb7bd2 r8d629de2  
    55<li><b>Starting Up</b><br>
    66If 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.
    7 You'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>).
    8 These <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.
     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.
    910Your <a href="/netdb">Network Database</a> indicates all known peers on the network.
    1011Additionally, you can monitor existing <a href="/peers">Peer Connections</a>, and view existing <a href="/tunnels">Tunnels</a> and their status.
     
    1213
    1314<li><b>Network Integration</b><br>
    14 The 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.
    15 When 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!
     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.
    1617Once 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>
    1718
     
    2223<ul class="links">
    2324
    24 <li><b>Invisible Internet &amp; Public Web Browsing</b><br>
    25 On 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.
     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.
    2627You can also access the normal web anonymously via I2P's built-in web proxy (outproxy).
    2728<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.
     
    2930In the "Sites of Interest" section <a href="#eepsites">below</a>, we list a few of the sites hosted on I2P.</li>
    3031
    31 <li><b>Anonymous E-Mail</b><br>
    32 Postman'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.
     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.
    3334Accounts can send and receive mail from the normal internet.
    3435For an account, visit <a href="http://hq.postman.i2p/" target="_blank">hq.postman.i2p</a>.
    35 Additionally, <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.
    36 It 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>
     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>
    3738
    3839<li><b>Anonymous File Transfer</b><br>
    3940<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.
    40 In addition, Sponge develops a bittorrent client called <a href="http://bob.i2p/Robert.html">Robert</a> written in Python.
    41 There 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>
    4241
    4342<li><b>Anonymous Chat</b><br>
    44 Start 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>.
     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>.
    4544You 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).
    4645Your 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.
    4746Once 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.
    4847There'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.
    49 And 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.
     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.
    5049We also provide full access to the <a href="http://docs.i2p-projekt.de/javadoc/" target="_blank">Java API</a>.</li>
    5150
    52 <li><b>Forums &amp; Blogging</b><br>
    53 If 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!].
    54 And, 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!
     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!
    5553Also, there are quite a few community run forums on I2P in various languages; see <a href="#eepsites">below</a> for some suggestions.</li>
    5654
     
    6765
    6866<li><b>Built-in Web-Server</b><br>
    69 I2P 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>.
     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>.
    7068To 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.
    7169You can also run any alternative web server platform over I2P and replace the built-in server, or run it on another tunnel.</li>
     
    113111</ul>
    114112
    115 <h2 id="trouble">Troubleshooting &amp; Further Assistance</h2>
     113<h2 id="trouble">Troubleshooting and Further Assistance</h2>
    116114
    117115<ul class="links">
    118116
    119117<li><b>Be Patient!</b><br>
    120 I2P may be slow to integrate into network the first time you run it as it bootstraps into the network and learns of additional peers.
     118I2P may be slow to integrate into network the first time you run it as it bootstraps into the network and finds peers.
    121119The 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!
    122120If, 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>
    123121
    124 <li><b>Check Your Configuration &amp; Bandwidth Allocation</b><br>
     122<li><b>Check Your Configuration and Bandwidth Allocation</b><br>
    125123I2P functions best when you can accurately reflect the speed of your network connection in the <a href="/config">bandwidth configuration section</a>.
    126124By 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.
    127125The more bandwidth you allocate, <i>specifically</i> upstream bandwidth, the more you will benefit from the network.</li>
    128126
    129 <li><b>Firewalls, Modems &amp; Routers</b><br>
     127<li><b>Firewalls, Modems and Routers</b><br>
    130128Where possible, please ensure I2P/Java is allowed un-firewalled access from the internet by configuring your modem/router/pc firewall accordingly.
    131129If 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".
     
    146144
    147145<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.
     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.
    149147Root privileges are usually not required to run I2P.
    150148If 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>
    151149
    152150<li><b>Enable Universal Plug and Play (UPnP)</b><br>
    153 Your 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.
    154 Ensure 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.
     151Your modem or router probably supports UPnP for automatic port forwarding.
     152Ensure UPnP support is enabled on your modem or router.
    155153Now try restarting the <a href="/">I2P router</a>.
    156154If successful, I2P should report "Network: OK" in the side panel once the I2P router completes initial connectivity tests.</li>
     
    166164
    167165<li><b>Reporting Bugs</b><br>
    168 If 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>.
     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>.
    169167For 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.
    170168Developers can browse source at <a href="https://github.com/i2p/i2p.i2p" target="_blank">Github</a>.
     
    181179
    182180<div class="topness"><a href="#top">[Return to Top]</a></div>
    183 <div class="footnote"><hr>Document updated: August 2018</div>
    184181</div>
Note: See TracChangeset for help on using the changeset viewer.