source: installer/resources/eepsite/docroot/help/index.html @ 2abaa4a

Last change on this file since 2abaa4a was 2abaa4a, checked in by zzz <zzz@…>, 4 years ago

fix html errors in help files

  • Property mode set to 100644
File size: 14.1 KB
Line 
1<!DOCTYPE html>
2<html lang="en">
3
4<head>
5  <title>I2P Anonymous WebServer</title>
6  <link rel="shortcut icon" href="favicon.ico" />
7  <link rel="stylesheet" type="text/css" href="lib/eepsite.css" />
8  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
9</head>
10
11<body>
12
13   <div class="main">
14
15   <div class="langbar">
16      <!-- Some of these languages listed here are yet to be translated -->
17      <a href="index.html"><img src="lib/us.png" title="English" alt="English"></a>
18      <a href="index_zh.html"><img src="lib/cn.png" title="中文" alt="中文"></a>
19      <a href="index_de.html"><img src="lib/de.png" title="Deutsch" alt="Deutsch"></a>
20      <a href="index_es.html"><img src="lib/es.png" title="Español" alt="Español"></a>
21      <a href="index_fr.html"><img src="lib/fr.png" title="Français" alt="Français"></a>
22      <a href="index_na.html"><img src="lib/ir.png" title="فارسی" alt="فارسی"></a>
23      <a href="index_na.html"><img src="lib/jp.png" title="日本語" alt="日本語"></a>
24      <a href="index_nl.html"><img src="lib/nl.png" title="Nederlands" alt="Nederlands"></a>
25      <a href="index_ru.html"><img src="lib/ru.png" title="Русский" alt="Русский"></a>
26      <a href="index_sv.html"><img src="lib/se.png" title="Svenska" alt="Svenska"></a>
27    </div>
28
29    <h1>I2P Anonymous Webserver</h1>
30
31    <h2>Quick Guide to Anonymous Webserving on I2P</h2>
32
33    <p>This is your own anonymous I2P webserver ("eepsite"). To serve your own content, simply edit the files in the webserver's
34      root directory and they'll be reachable by others once you follow the instructions below.
35    </p>
36
37    <p>The webserver's root directory can be found in the following location:
38    </p>
39
40    <ul>
41      <li><code>~/.i2p/eepsite/docroot/</code> <b>(Linux)</b>
42      </li>
43      <li><code>%APPDATA%\I2P\eepsite\docroot\</code> <b>(Windows)</b>
44      </li>       
45      <li><code>/Users/(user)/Library/Application Support/i2p</code> <b>(Mac)</b>
46      </li>
47    </ul>
48
49    <p>In I2P, hidden services are addressed using a 'key', which is represented as a really long
50      <a href="https://en.wikipedia.org/wiki/Base64" target="_blank">Base64</a> string. (The 'key'
51      is somewhat analogous to an IP address, and is shown on the
52      <a href="http://127.0.0.1:7657/i2ptunnel/edit.jsp?tunnel=3">Hidden Service Configuration page</a>).
53    </p>
54
55    <p>The instructions below detail how to assign a name like "mysite.i2p" to your key and start up your website. You can
56      reach your site locally via <a href="http://127.0.0.1:7658/">http://127.0.0.1:7658/</a>.
57    </p>
58
59    <h2>How to set up and announce your hidden service website</h2>
60
61    <p>Your website is stopped by default. After you start it, it will be difficult for other people to find because it
62      doesn't have a name and they don't have your really long Base64 key. You could just tell people that really long
63      key, but thankfully I2P has an address book and several easy ways to tell people about your website. Here's detailed
64      instructions.
65    </p>
66
67    <ul>
68      <li>Pick a name for your website (<i>something</i>.i2p). Use all lower-case. You may wish to check first in your own
69         router's address book
70         <a href="http://127.0.0.1:7657/susidns/addressbook.jsp?book=router&amp;filter=none">here</a>, or the file
71         <code>i2p/hosts.txt</code> to see if your name is already taken. Enter the new name for your website on the
72         <a href="http://127.0.0.1:7657/i2ptunnel/edit.jsp?tunnel=3">Hidden Service Configuration page</a> where it says
73         "Website name". This will replace the default "mysite.i2p". Also, check the "Auto Start" box. Your website will
74         now start every time you start your router. Be sure to click "Save".
75      </li>
76      <li>Click the start button for your website on the
77         <a href="http://127.0.0.1:7657/i2ptunnel/index.jsp">main Hidden Service Manager page</a>. You should now see
78         it listed under "Local Tunnels" on the left side of the
79         <a href="http://127.0.0.1:7657/index.jsp">I2P Router Console</a>. Your website is now running.
80      </li>
81      <li>Highlight the entire "Local destination" key on the
82         <a href="http://127.0.0.1:7657/i2ptunnel/edit.jsp?tunnel=3">Hidden Service Configuration page</a>. and copy it
83         for later pasting. Make sure you get the whole thing - it's over 500 characters.
84      </li>
85      <li>Enter the name and paste in the destination key into your
86         <a href="http://127.0.0.1:7657/susidns/addressbook.jsp?book=master">master address book</a>. Click "Add" to add
87         the destination to your address book.
88      </li>
89      <li>In your browser, enter in your website name (<i>something</i>.i2p) and you should be right back here. Hopefully
90         it worked.
91      </li>
92      <li>Before you tell the world about your new website, you should add some content. Go to the following directory and
93         replace the index.html redirect page with your own content:
94         <ul>
95           <li><code>~/.i2p/eepsite/docroot/</code> <b>(Linux)</b>
96           </li>
97           <li><code>%APPDATA%\I2P\eepsite\docroot\</code> <b>(Windows)</b>
98           </li>
99           <li><code>/Users/(user)/Library/Application Support/i2p</code> <b>(Mac)</b>
100           </li>
101           </ul>
102      </li>
103    </ul>           
104
105    <p>Virtual folders work, so you can host files from a sub directory without explicitly needing to provide a page
106      with links to files. You can change the appearance of the directory listing by supplying an edited jetty-dir.css file
107      for each of the directories you are serving, demonstrated <a href="lib/">here</a>. The
108      <a href="lib/resources">resources sub-directory</a> (containing filetype images for the directory listing)
109      reverts to the default style. If you need a template for a basic site, feel free to borrow and adapt
110      <a href="pagetemplate.html">this page</a> and <a href="lib/">content</a>!
111    </p>
112
113    <p>If you're returned to this page after editing the content, try clearing your browser's web cache:</p>
114
115    <ul>
116      <li>in <b>Firefox</b> via: Preferences ➜ Advanced ➜ Network ➜ Cached Web Content ➜ Clear Now</li>
117      <li>in <b>Chrome/Chromium</b> via: Settings ➜ Advanced Settings ➜ Privacy ➜ Clear browsing data...</li>
118      <li> in <b>Opera</b> via: Settings ➜ Privacy ➜ Clear browsing data...
119    </ul>
120
121    <h2>Register your own .I2P Domain</h2>
122
123    <p>Now it's time to add your website to an I2P address book hosted by a site such as
124      <a href="http://stats.i2p/ " target="_blank">stats.i2p</a>
125      or <a href="http://no.i2p/" target="_blank">no.i2p</a>. That is, you must enter your website name and key into a web interface
126      on one or more of these sites. Here is <a href="http://stats.i2p/i2p/addkey.html" target="_blank">the key entry form</a> at stats.i2p.
127      Again, your key is the entire "Local destination" key on the
128      <a href="http://127.0.0.1:7657/i2ptunnel/edit.jsp?tunnel=3">Hidden Service Configuration page</a>. Be sure you
129      get the whole thing. Don't forget to click "add a key". Check to see if it reports the key was added. Since many
130      routers periodically get address book updates from these sites, within several hours others will be able to find
131      your website by simply typing <i>something</i>.i2p into their browser.</p>
132    <h2>Adding Addressbook Subscriptions</h2>
133
134    <p>Speaking of address book updates, this would be a good time to add some more addressbooks to your own
135          subscription list. Go to your <a href="http://127.0.0.1:7657/susidns/subscriptions.jsp">Subscriptions Configuration
136          page</a> and add a couple of these for an automatically updated list of new hosts:
137    </p>
138
139    <ul>
140      <li><code>http://stats.i2p/cgi-bin/newhosts.txt</code> (<a href="http://stats.i2p/cgi-bin/newhosts.txt" target="_blank">stats.i2p</a>)
141      </li>
142      <li><code>http://i2host.i2p/cgi-bin/i2hostetag</code> (<a href="http://i2host.i2p/cgi-bin/i2hostetag" target="_blank">i2host.i2p</a>)
143      </li>
144      <li><code>http://no.i2p/export/alive-hosts.txt</code> (<a href="http://no.i2p/export/alive-hosts.txt" target="_blank">no.i2p</a>)
145      </li>
146    </ul>
147   
148    <p>If you are in a hurry and can't wait a few hours, you can tell people to use a "jump" address helper redirection
149      service. This will work within a few minutes of your entering the key to an address book on the same site. Test
150      it yourself first by entering <code>http://stats.i2p/cgi-bin/jump.cgi?a=<i>something</i>.i2p</code> or
151      <code>http://i2host.i2p/cgi-bin/i2hostjump?<i>something</i>.i2p</code> into your browser.
152      Once it's working, you can tell others to use it.
153    </p>
154<!--
155        <p>Some people check website lists such as <a href="http://inproxy.tino.i2p/status.php">inproxy.tino.i2p/status.php</a>
156          or <a href="http://perv.i2p">perv.i2p</a> for new eepsites, so you may start getting a few visitors. But there
157          are plenty of other ways to tell people. Here are a few ideas:</p>
158-->
159
160    <p>Some people check website lists such as <a href="http://identiguy.i2p/" target="_blank">Identiguy's eepsite status list</a>
161      or <a href="http://no.i2p/browse/" target="_blank">no.i2p's active host list</a> for new eepsites, so you may start getting a few
162      visitors. But there are plenty of other ways to tell people. Here are a few ideas:
163    </p>
164
165    <ul>
166      <li>Post a message on the <a href="http://forum.i2p/viewforum.php?f=16" target="_blank">Eepsite announce forum</a> on
167        <a href="http://forum.i2p/" target="_blank">forum.i2p</a>.
168      </li>
169      <li>Tell people about it on the #i2p or #i2p-chat channels on IRC.
170      </li>
171      <li>Put it in a new post on <a href="http://syndie.i2p2.de/" target="_blank">the new Syndie</a>.
172      </li>
173      <li>Put it on <a href="http://ugha.i2p/EepsiteIndex" target="_blank">Ugha Wiki's Eepsite Index</a>
174      </li>
175    </ul>
176
177    <p>Note that some sites recommend pasting in that really long destination key. You can if you want - but if you have
178      successfully posted your key at an add-key service, tested it using a jump service, and waited 24 hours for the
179      address book update to propagate to others, that shouldn't be necessary.</p>
180
181    <h2>Using an alternative webserver to host your site</h2>
182
183    <p>This site (and the I2P router console) is running on the
184      <a href="https://en.wikipedia.org/wiki/Jetty_(web_server)" target="_blank">Jetty webserver</a>,
185      but you may want to use a different webserver to host your content.
186      To maintain anonymity, be sure that your webserver is configured to only allow connections from localhost (127.0.0.1),
187      and check the documentation to ensure your webserver isn't advertising details that may compromise your anonymity.
188    </p>
189
190     <p>To configure your webserver for use on I2P, you can either use the existing webserver tunnel and
191       <a href="http://127.0.0.1:7657/configclients">disable the default webserver</a> from running,
192       or create a new HTTP Server tunnel in the <a href="http://127.0.0.1:7657/i2ptunnelmgr">Hidden Services Manager</a>.
193       Whatever you choose, you need to make sure the listening port configured for the webserver (7658 by default for the I2P webserver
194       Jetty instance) is also configured in the Hidden Services Webserver settings. So, for example if your webserver is listening
195       by default on address 127.0.0.1 port 80, you'd need to also ensure that the Target port in the Hidden Service Manager settings page
196       for the service is also configured to port 80.
197        </p> 
198
199        <p>Please be aware that a poorly configured webserver or web appplication can leak potentially compromising information such as
200          your real ip address or server details that may reduce your anonymity or assist a hacker, which is why it's recommended to use the
201          default server until you're up to speed on securing your alternative server and any webapps you may be running,
202          for which there are many guides on the internet. The following may be of help:
203        </p>
204
205        <ul>
206           <li><a href="https://geekflare.com/apache-web-server-hardening-security/" target="_blank">Apache Web Server Hardening
207              &amp; Security Guide</a>
208           </li>
209           <li><a href="https://geekflare.com/nginx-webserver-security-hardening-guide/" target="_blank">Nginx Web Server Security
210              &amp; Hardening Guide</a>
211           </li>
212           <li><a href="https://www.wordfence.com/learn/how-to-harden-wordpress-sites/" target="_blank">How to Harden Your WordPress
213              Site From Attacks</a></li>
214        </ul>         
215
216        <h2>Further Assistance</h2>
217
218        <p>If you have any questions, the following places are available for support:
219        </p>
220
221        <ul>
222          <li>Our IRC support channel:
223             <ul>
224                <li><a href="irc://irc.freenode.net/i2p">#i2p on Freenode</a>
225                </li>
226                <li>Anonymously via your resident <a href="irc://127.0.0.1:6668/i2p-help">I2P IRC tunnel</a>.</li>
227             </ul>
228            <li><a href="http://forum.i2p/viewforum.php?f=10" target="_blank">The technical problems section</a> on
229              <a href="http://forum.i2p/" target="_blank">forum.i2p</a>.
230            </li>
231            <li><a href="http://ugha.i2p/EepsiteHosting" target="_blank">Ugha Wiki's Eepsite Hosting guide</a> or
232              <a href="http://i2pwiki.i2p/index.php?title=EepsiteHosting" target="_blank">I2PWiki's Eepsite Hosting guide</a>
233            </li>
234        </ul>
235
236        <div class="notify">
237          <b>Note:</b> This page, the website and the console all need translating into YOUR language if it's not already
238          been done or in progress. Please consider helping the project grow by <a href="http://www.i2p2.i2p/getinvolved.html" target="_blank">
239          volunteering your time</a> to <a href="http://i2p-projekt.i2p/en/get-involved/guides/new-translators" target="_blank">translate</a>. Contact the project via the IRC channel listed above. Thanks in advance!
240        </div>
241       
242        <hr>
243
244        <div class="footnote">
245          Document last edited: July 2016.
246       </div>
247
248  </div>
249</body>
250</html>
Note: See TracBrowser for help on using the repository browser.