From e2ca8d326855b5dcd035318f5c1d80e01ea5d240 Mon Sep 17 00:00:00 2001
From: Sadie Mascis <50714166+Shoalsteed@users.noreply.github.com>
Date: Wed, 5 Apr 2023 14:41:50 -0400
Subject: [PATCH] Update readme.html
---
apps/routerconsole/resources/docs/readme.html | 95 ++++++++-----------
1 file changed, 42 insertions(+), 53 deletions(-)
diff --git a/apps/routerconsole/resources/docs/readme.html b/apps/routerconsole/resources/docs/readme.html
index 5cb933425..6f9382ea2 100644
--- a/apps/routerconsole/resources/docs/readme.html
+++ b/apps/routerconsole/resources/docs/readme.html
@@ -2,50 +2,43 @@
-- Starting Up
-If you've just started I2P, the number of Active Peers indicated under the Peers section in the side panel on the left should start to grow over the next few minutes.
-When your router is ready, you'll also see a Local Tunnel named Shared Clients listed there, and possibly other clients and servers.
-If not, see the troubleshooting section below.
-These Local Tunnels provide connections to the I2P network, enabling your bittorrent, email, web proxy and other services.
-Your Network Database indicates all known peers on the network.
-Additionally, you can monitor existing Peer Connections, and view existing Tunnels and their status.
-More information is available on the help page.
-
- Network Integration
-When 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.
-When 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.
-Once green circles are indicated next to your Local Tunnels, there is a wide variety of things you can do with I2P, and below we introduce you to some of them.
+If you have just installed and started an I2P router, the number of Active Peers indicated under the Peers section in the side panel on the left will increase over the next few minutes.
+When an I2P router starts up, and during its regular operation, the tunnel build readiness indicator in the side panel may indicate that it is "Rejecting Tunnels." This is a normal behaviour.
+
+Once the router has joined the network, a Local named Shared Clients will appear. If not, see the troubleshooting section [below](http://127.0.0.1:7657/console#trouble). Local Tunnels provide connections to the I2P network, enabling bittorrent, email, web proxy and other services. The [Network Database](http://127.0.0.1:7657/netdb) indicates all known peers on the network. Additionally, you can monitor existing [Peer Connections](http://127.0.0.1:7657/peers), and view existing [Tunnels](http://127.0.0.1:7657/tunnels) and their status. More information is available on the [help page](http://127.0.0.1:7657/help). Once green circles are indicated next to your Local Tunnels, you can access the I2P network.
+
-Services on I2P
+Applications And Services
-- Hidden Services and Public Web Browsing
-On I2P you can access hidden service websites ("I2P sites") and other services, and you can host your own services.
-You can also access the normal web anonymously via I2P's built-in web proxy (outproxy).
-Configure your browser to use the HTTP proxy at 127.0.0.1 port 4444, then browse to an I2P Site or website at an http:// or https:// address.
-If you wish to disable or change outproxy access to the non-anonymous internet, remove or modify the outproxy entry for false.i2p under the Outproxies option in the I2P HTTP Proxy Tunnel Editor.
-In the "Sites of Interest" section below, we list a few of the sites hosted on I2P.
-There are also a number of semi-official and unofficial efforts to build browsing tools for I2P,
+ - I2P Browsing Functions
+A properly configured browser is needed for accessing content on the I2P network (I2P sites and services) and accessing clearnet content using the outproxy service specified in the Hidden Services Manager of the I2P router.
+Configure your browser to use the HTTP proxy at 127.0.0.1 port 4444.
+If you wish to disable or change outproxy access, remove or modify the outproxy entry for exit.stormycloud.i2p in the Outproxies option in the I2P HTTP Proxy Tunnel Editor.
+There are semi-official and unofficial efforts to build browsing tools for I2P,
including a preconfigured Firefox Browser profile,
an easy-to-install WebExtension,
or via automatic launchers in privacy-focused Linux distributions like Whonix.
-While these are all interesting projects, please evaluate them to see if they fit within your personal threat
-model before trusting them with your well-being.
+The easiest way to check if I2P network access is functioning properly is to visit /home of the I2P router console and click on the I2P website link in the Community section.
+
+If an I2P site address is not in your router address book, you will be prompted to use a jump service and given the option in the process.
-- Anonymous Email
-Postman's I2P-based mail system can be accessed either via I2P's built-in mail client or with any external mail client.
-Accounts can send and receive mail from the normal internet.
+ - Email
+Postman's I2P-based mail (SusiMail) service can be accessed either via I2P's built-in mail client or with any external mail client.
+It is primarily intended for use with Postman’s email servers inside of the I2P network. It is designed to avoid leaking information about email use to other networks. SusiMail is bridged so it can send and receive email from the internet as well. Occasionally you may see some services like Gmail classifying it as spam, which you can correct in your Internet email service providers settings.
For an account, visit hq.postman.i2p.
-- Anonymous File Transfer
-I2PSnark is integrated into I2P, providing anonymous, encrypted BitTorrent transfers.
+ - I2PSnark BitTorrent Client
+I2PSnark Snark is an I2P network only BitTorrent client. It never makes a connection to a peer over any other network.
+
-- Anonymous Chat
+ - IRC/Chat
Start your IRC client (e.g. HexChat) and connect to the server at 127.0.0.1 port 6668.
You 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).
Your local I2P IRC tunnel on localhost:6668 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.
@@ -54,18 +47,22 @@ I2P is also suitable for unmonitorable and uncensorable anonymous chat, as well
You may run your own servers over I2P in whatever flavor you choose, or if you're a developer write your own I2P applications.
Both UDP and TCP protocols are supported.
-- Forums and Blogging
-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!
-Also, there are quite a few community run forums on I2P in various languages; see below for some suggestions.
+- The AddressBook
+This is a locally-defined list of human-readable addresses (ie: i2p-projekt.i2p) and corresponding I2P addresses.(udhdrtrcetjm5sxzskjyr5ztpeszydbh4dpl3pl4utgqqw2v4jna.b32.i2p) It integrates with other applications to allow you to use those human-readable addresses in place of those I2P addresses. It is more similar to a hosts file or a contact list than a network database or a DNS service. There is no recognized global namespace, you decide what any given .i2p domain maps too in the end.
+
+- The QR Code Generator
+Besides the Address Book, I2P addresses can be shared by converting them into QR codes and scanning them with a camera. This is especially useful for Android devices.
+
+- I2P Hidden Services Manager
+This is a general-purpose adapter for forwarding services ( ie SSH ) into I2P and proxying client requests to and from I2P. It provides a variety of “Tunnel Types” which are able to do advance filtering of traffic before it reaches I2P.
- Plugins for I2P
-Extend the usefulness of I2P by installing plugins: blogging, chatting, file sharing and other plugins have already been written or ported and await your installation!
-Browse the plugins and related info at wiki.i2p-projekt.i2p.
+Browse plugins and related information at wiki.i2p-projekt.i2p.
If you're a developer, a complete framework for writing your own plugins is provided with documentation.
-Anonymous Encrypted Web Hosting on I2P
+Self-Host An I2P Site
@@ -78,32 +75,28 @@ You can also run any alternative web server platform over I2P and replace the bu
After starting up, your pre-configured I2P Webserver Tunnel, your website will be visible (but not discoverable) to others.
Detailed instructions for starting your website, registering an .i2p domain and promoting your site to others are accessible via your own I2P webserver on http://127.0.0.1:7658/help/.
+- Forums and Blogging
+Most blogging, forum and CMS software are compatible with the I2P network, It is 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.
+
+
-I2P-Hidden Services of Interest
+I2P Community Resources
- Invisible Internet Project (I2P) Official Website
i2p-projekt.i2p: Secure and anonymous connections to geti2p.net. If you want to know more about how I2P works or how you can participate, this is the first place to visit!
-- I2P Community Forums
-zzz's developer forums hosts discussion related to I2P development.
-
-i2pforum.i2p: A forum where problems and ideas relating to I2P and associated topics are discussed.
+i2pforum.i2p: A forum where I2P topics are discussed.
- I2P Planet
-planet.i2p: 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!
-
-- I2P Network Health
-stats.i2p: Check out various aspects of network performance with this I2P network monitoring site run by zzz.
+planet.i2p: An RSS aggregator site that takes news and events from around the I2P network and publishes them all in one place. A good site to visit to see the community at work.
- I2P Bug Tracker - GitLab
git.idk.i2p: I2P's issue reporting and bug-tracking system. Please visit if you have an issue to report, also available at https://i2pgit.org/
-- Discover I2P
-There are many more hidden services - just follow the links from the ones you see, bookmark your favourites, and visit them often!
@@ -111,9 +104,9 @@ There are many more hidden services - just follow the links from the ones you se
-- Be Patient!
-I2P may be slow to integrate into network the first time you run it as it bootstraps into the network and finds peers.
-The 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!
+ - Network Integration
+Your I2P router may be slow to integrate into network the first time you run it as it bootstraps into the network and finds peers.
+The 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.
If, after 30 minutes, your Active: [connected/recent] count still has less than 10 peers, or your total number of Integrated peers is less than 5, there are several things you can do to check for problems:
- Check Your Configuration and Bandwidth Allocation
@@ -165,11 +158,7 @@ For developer-related discussions, please visit git.idk.i2p.
- Get Involved!
-I2P is developed and maintained mostly through unfunded, voluntary participation by community members.
-We're happy to accept donations, which go into essential hosting and administrative costs.
-We have cash bounties for aspects of I2P for developers looking for incentives to participate, and we're always looking for more Java coders, translators, promoters and users to help I2P grow.
-The 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.
-For further info on how you can participate, visit the volunteers page on the website.
+For information about how you can help the network or participate in I2P core development, visit the volunteers page on the website.