From 75981491a7b5a197d4730d54a94c97e481517806 Mon Sep 17 00:00:00 2001
From: libre-net-society <l-n-s@sigaint.org>
Date: Sat, 3 Sep 2016 22:23:48 +0300
Subject: [PATCH] adding usage docs

---
 docs/index.rst |   1 +
 docs/usage.md  | 130 +++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 131 insertions(+)
 create mode 100644 docs/usage.md

diff --git a/docs/index.rst b/docs/index.rst
index 13cd9edb..5507b075 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -35,5 +35,6 @@ Contents:
    build_notes_android
    configuration
    family
+   usage
 
 
diff --git a/docs/usage.md b/docs/usage.md
new file mode 100644
index 00000000..cb678cb4
--- /dev/null
+++ b/docs/usage.md
@@ -0,0 +1,130 @@
+Usage and tutorials
+===================
+
+
+i2pd can be used for:
+
+* [anonymous websites](#browsing-and-hosting-websites)
+* [anonymous chats](#using-and-hosting-chat-servers)
+* [anonymous file sharing](#file-sharing)
+
+and many more.
+
+## Browsing and hosting websites
+
+### Browse anonymous websites
+
+To browse anonymous websites inside Invisible Internet, configure your web browser to use HTTP proxy 127.0.0.1:4444 (available by default in i2pd).
+
+In Firefox: Preferences -> Advanced -> Network tab -> Connection Settings -> choose Manual proxy configuration, Enter HTTP proxy 127.0.0.1, Port 4444
+
+In Chromium: run chromium executable with key
+
+    chromium --proxy-server="http://127.0.0.1:4444"
+
+Note that if you wish to stay anonymous too you'll need to tune your browser for better privacy. Do your own research, [can start here](http://www.howtogeek.com/102032/how-to-optimize-mozilla-firefox-for-maximum-privacy/).
+
+Big list of Invisible Internet websites can be found at [identiguy.i2p](http://identiguy.i2p).
+
+### Host anonymous website
+
+
+If you wish to run your own website in Invisible Internet, follow those steps:
+
+1) Run your webserver and find out which host:port it uses (for example, 127.0.0.1:8080).
+
+2) Configure i2pd to create HTTP server tunnel. Put in your ~/.i2pd/tunnels.conf file:
+
+    [anon-website]
+    type = http
+    host = 127.0.0.1
+    port = 8080
+    keys = anon-website.dat
+
+3) Restart i2pd.
+
+4) Find b32 destination of your website.
+
+Go to webconsole -> [I2P tunnels page](http://127.0.0.1:7070/?page=i2p_tunnels). Look for Sever tunnels and you will see address like \<long random string\>.b32.i2p next to anon-website.
+
+Website is now available in Invisible Internet by visiting this address.
+
+5) (Optional) Register short and rememberable .i2p domain on [inr.i2p](http://inr.i2p).
+
+
+## Using and hosting chat servers
+
+### Running anonymous IRC server
+
+1) Run your IRC server software and find out which host:port it uses (for example, 127.0.0.1:5555).
+
+For small private IRC servers you can use [miniircd](https://github.com/jrosdahl/miniircd), for large public networks [UnreadIRCd](https://www.unrealircd.org/).
+
+2) Configure i2pd to create IRC server tunnel.
+
+Simplest case, if your server does not support WebIRC, add this to ~/.i2pd/tunnels.conf:
+
+    [anon-chatserver]
+    type = irc
+    host = 127.0.0.1     
+    port = 5555
+    keys = chatserver-key.dat
+
+And that is it.
+
+Alternatively, if your IRC server supports WebIRC, for example, UnreadIRCd, put this into UnrealIRCd config:
+
+    webirc {
+        mask 127.0.0.1;
+        password your_password;
+    };
+
+Also change line:
+
+    modes-on-connect "+ixw";
+
+to
+
+    modes-on-connect "+iw";
+
+And this in ~/.i2pd/tunnels.conf:
+
+    [anon-chatserver]
+    type = irc
+    host = 127.0.0.1
+    port = 5555
+    keys = chatserver-key.dat
+    webircpassword = your_password
+
+3) Restart i2pd.
+
+4) Find b32 destination of your anonymous IRC server.
+
+Go to webconsole -> [I2P tunnels page](http://127.0.0.1:7070/?page=i2p_tunnels). Look for Sever tunnels and you will see address like \<long random string\>.b32.i2p next to anon-chatserver.
+
+Clients will use this address to connect to your server anonymously.
+
+### Connect to anonymous IRC server
+
+To connect to IRC server at *walker.i2p*, add this to ~/.i2pd/tunnels.conf:
+
+    [IRC2]
+    type = client
+    address = 127.0.0.1
+    port = 6669
+    destination = walker.i2p
+    #keys = walker-keys.dat
+
+Restart i2pd, then connect to irc://127.0.0.1:6669 with your IRC client.
+
+## File sharing
+
+You can share and download torrents with [Transmission-I2P](https://github.com/l-n-s/transmission-i2p).
+
+Alternative torrent-clients are [Robert](http://en.wikipedia.org/wiki/Robert_%28P2P_Software%29) and [Vuze](https://en.wikipedia.org/wiki/Vuze).
+
+Robert uses BOB protocol, i2pd must be run with parameter --bob.enabled=true.
+
+Vuze uses I2CP protocol, i2pd must be run with parameter --i2cp.enabled=true.
+
+Also, visit [postman tracker](http://tracker2.postman.i2p).