source: installer/resources/eepsite/docroot/help/index.html @ 98019bb

Last change on this file since 98019bb was 98019bb, checked in by slumlord <slumlord@…>, 3 years ago

Updates to eepsite help page

  • Property mode set to 100644
File size: 14.4 KB
1<!DOCTYPE html>
2<html lang="en">
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">
13   <div class="main">
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>
29    <h1>I2P Anonymous Webserver</h1>
31    <h2>Quick Guide to Anonymous Webserving on I2P</h2>
33    <p>
34      This is your own anonymous I2P webserver (traditionally referred to as an <i>eepsite</i>) To serve your own content, simply
35      edit the files in the webserver's root directory and they'll be reachable by others once you follow the instructions below.
36    </p>
38    <p>The webserver's root directory can be found in the following locations, depending on your Operating System:
39    </p>
41    <ul>
42      <li> <b>Linux</b><br>
43        <code>~/.i2p/eepsite/docroot/</code>
44      </li>
45      <li> <b>Windows</b><br>
46        <code>%APPDATA%\I2P\eepsite\docroot\</code>
47      </li>       
48      <li> <b>Mac</b><br>
49        <code>/Users/(user)/Library/Application Support/i2p</code>
50      </li>
51    </ul>
53    <p>In I2P, hidden services are addressed using a 'key', which is represented as a really long
54      <a href="" target="_blank">Base64</a> string. (The 'key'
55      is somewhat analogous to an IP address, and is shown on the
56      <a href="">Hidden Service Configuration page</a>).
57    </p>
59    <p>The instructions below detail how to assign a name like "mysite.i2p" to your key and start up your website. You can
60      reach your site locally via <a href=""></a>.
61    </p>
63    <h2>How to set up and announce your hidden service website</h2>
65     <p>Your website is stopped by default. After you start your I2P Webserver
66      tunnel, it will be difficult for other people to find - it can only be
67      accessed with your Base64 string or with the b32, which is a SHA256 hash
68      of the Base64 string. You could just tell people that really long key,
69      but thankfully I2P has an address book and several easy ways to tell
70      people about your website. Here are detailed instructions.
71    </p>
73    <ul>
74      <li>Pick a name for your website (<i>something</i>.i2p). Use all lower-case. You may wish to check first in your own
75        router's address book
76        <a href=";filter=none">here</a>, or the file
77        <code>i2p/hosts.txt</code> to see if your name is already taken. Enter the new name for your website on the
78        <a href="">Hidden Service Configuration page</a> where it says
79        "Website name". This will replace the default "mysite.i2p". Also, if you would like your I2P Webserver tunnel
80        to be automatically started when you start I2P, check the "Auto Start" box. Your website will now start every time
81        you start your router. Be sure to click "Save".
82      </li>
83      <li>Click the start button for your website on the
84         <a href="">main Hidden Service Manager page</a>. You should now see
85         it listed under "Local Tunnels" on the left side of the
86         <a href="">I2P Router Console</a>. Your website is now running.
87      </li>
88      <li>Highlight the entire "Local destination" key on the
89         <a href="">Hidden Service Configuration page</a>. and copy it
90         for later pasting. Make sure you get the whole thing - it's over 500 characters.
91      </li>
92      <li>Enter the name and paste in the destination key into your
93         <a href="">master address book</a>. Click "Add" to add
94         the destination to your address book.
95      </li>
96      <li>In your browser, enter in your website name (<i>something</i>.i2p) and you should be right back here. Hopefully
97         it worked.
98      </li>
99      <li>Before you tell the world about your new website, you should add some content. Go to the following directory and
100         replace the index.html redirect page with your own content:
101        <ul>
102          <li> <b>Linux</b><br>
103            <code>~/.i2p/eepsite/docroot/</code>
104          </li>
105          <li> <b>Windows</b><br>
106            <code>%APPDATA%\I2P\eepsite\docroot\</code>
107          </li>       
108          <li> <b>Mac</b><br>
109            <code>/Users/(user)/Library/Application Support/i2p</code>
110          </li>
111        </ul>
112      </li>
113    </ul>           
115    <p>Virtual folders work, so you can host files from a sub directory without explicitly needing to provide a page
116      with links to files. You can change the appearance of the directory listing by supplying an edited jetty-dir.css file
117      for each of the directories you are serving, demonstrated <a href="lib/">here</a>. The
118      <a href="lib/resources">resources sub-directory</a> (containing filetype images for the directory listing)
119      reverts to the default style. If you need a template for a basic site, feel free to borrow and adapt
120      <a href="pagetemplate.html">this page</a> and <a href="lib/">content</a>!
121    </p>
123    <p>If you're returned to this page after editing the content, try clearing your browser's web cache:</p>
125    <ul>
126      <li>in <b>Firefox</b> via: Preferences ➜ Advanced ➜ Network ➜ Cached Web Content ➜ Clear Now</li>
127      <li>in <b>Chrome/Chromium</b> via: Settings ➜ Advanced Settings ➜ Privacy ➜ Clear browsing data...</li>
128      <li> in <b>Opera</b> via: Settings ➜ Privacy ➜ Clear browsing data...
129    </ul>
131    <h2>Register your own .I2P Domain</h2>
133    <p>Now it's time to add your website to an I2P address book hosted by a site such as
134      <a href="http://stats.i2p/ " target="_blank">stats.i2p</a>
135      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
136      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.
137      Again, your key is the entire "Local destination" key on the
138      <a href="">Hidden Service Configuration page</a>. Be sure you
139      get the whole thing. Don't forget to click "add a key". Check to see if it reports the key was added. Since many
140      routers periodically get address book updates from these sites, within several hours others will be able to find
141      your website by simply typing <i>something</i>.i2p into their browser.</p>
142    <h2>Adding Addressbook Subscriptions</h2>
144    <p>Speaking of address book updates, this would be a good time to add some more addressbooks to your own
145          subscription list. Go to your <a href="">Subscriptions Configuration
146          page</a> and add a couple of these for an automatically updated list of new hosts:
147    </p>
149    <ul>
150      <li><code>http://stats.i2p/cgi-bin/newhosts.txt</code> (<a href="http://stats.i2p/cgi-bin/newhosts.txt" target="_blank">stats.i2p</a>)
151      </li>
152      <!--<li><code>http://i2host.i2p/cgi-bin/i2hostetag</code> (<a href="http://i2host.i2p/cgi-bin/i2hostetag" target="_blank">i2host.i2p</a>)
153      </li>-->
154      <li><code>http://no.i2p/export/alive-hosts.txt</code> (<a href="http://no.i2p/export/alive-hosts.txt" target="_blank">no.i2p</a>)
155      </li>
156    </ul>
158    <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
159      service. This will work within a few minutes of your entering the key to an address book on the same site. Test
160      it yourself first by entering <code>http://stats.i2p/cgi-bin/jump.cgi?a=<i>something</i>.i2p</code> <!--or
161      <code>http://i2host.i2p/cgi-bin/i2hostjump?<i>something</i>.i2p</code>--> into your browser.
162      Once it's working, you can tell others to use it.
163    </p>
165        <p>Some people check website lists such as <a href="http://inproxy.tino.i2p/status.php">inproxy.tino.i2p/status.php</a>
166          or <a href="http://perv.i2p">perv.i2p</a> for new eepsites, so you may start getting a few visitors. But there
167          are plenty of other ways to tell people. Here are a few ideas:</p>
170    <p>Some people check website lists such as <a href="http://identiguy.i2p/" target="_blank">Identiguy's eepsite status list</a>
171      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
172      visitors. But there are plenty of other ways to tell people. Here are a few ideas:
173    </p>
175    <ul>
176      <li>Post a message on the <a href="http://i2pforum.i2p/" target="_blank">I2P forum</a> telling everyone about your new I2P website!
177      </li>
178      <li>Tell people about it on the #i2p or #i2p-chat channels on IRC.
179      </li>
180      <li>Put it in a new post on <a href="" target="_blank">the new Syndie</a>.
181      </li>
182      <li>Put it on <a href="http://ugha.i2p/EepsiteIndex" target="_blank">Ugha Wiki's Eepsite Index</a>
183      </li>
184    </ul>
186    <p>Note that some sites recommend pasting in that really long destination key. You can if you want - but if you have
187      successfully posted your key at an add-key service, tested it using a jump service, and waited 24 hours for the
188      address book update to propagate to others, that shouldn't be necessary.</p>
190    <h2>Using an alternative webserver to host your site</h2>
192    <p>This site (and the I2P router console) is running on the
193      <a href="" target="_blank">Jetty webserver</a>,
194      but you may want to use a different webserver to host your content.
195      To maintain anonymity, be sure that your webserver is configured to only allow connections from localhost (,
196      and check the documentation to ensure your webserver isn't advertising details that may compromise your anonymity.
197    </p>
199     <p>To configure your webserver for use on I2P, you can either use the existing webserver tunnel and
200       <a href="">disable the default webserver</a> from running,
201       or create a new HTTP Server tunnel in the <a href="">Hidden Services Manager</a>.
202       Whatever you choose, you need to make sure the listening port configured for the webserver (7658 by default for the I2P webserver
203       Jetty instance) is also configured in the Hidden Services Webserver settings. So, for example if your webserver is listening
204       by default on address port 80, you'd need to also ensure that the Target port in the Hidden Service Manager settings page
205       for the service is also configured to port 80.
206        </p> 
208        <p>Please be aware that a poorly configured webserver or web appplication can leak potentially compromising information such as
209          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
210          default server until you're up to speed on securing your alternative server and any webapps you may be running,
211          for which there are many guides on the internet. The following may be of help:
212        </p>
214        <ul>
215           <li><a href="" target="_blank">Apache Web Server Hardening
216              &amp; Security Guide</a>
217           </li>
218           <li><a href="" target="_blank">Nginx Web Server Security
219              &amp; Hardening Guide</a>
220           </li>
221           <li><a href="" target="_blank">How to Harden Your WordPress
222              Site From Attacks</a></li>
223        </ul>         
225        <h2>Further Assistance</h2>
227        <p>If you have any questions, the following places are available for support:
228        </p>
230        <ul>
231          <li>Our IRC support channel:
232             <ul>
233                <li><a href="irc://">#i2p on Freenode</a>
234                </li>
235                <li>Anonymously via your resident <a href="irc://">I2P IRC tunnel</a>.</li>
236             </ul>
237            <li><a href="http://forum.i2p/viewforum.php?f=10" target="_blank">The technical problems section</a> on
238              <a href="http://forum.i2p/" target="_blank">forum.i2p</a>.
239            </li>
240            <li><a href="http://ugha.i2p/EepsiteHosting" target="_blank">Ugha Wiki's Eepsite Hosting guide</a> or
241              <a href="http://i2pwiki.i2p/index.php?title=EepsiteHosting" target="_blank">I2PWiki's Eepsite Hosting guide</a>
242            </li>
243        </ul>
245        <div class="notify">
246          <b>Note:</b> This page, the website and the console all need translating into YOUR language if it's not already
247          been done or in progress. Please consider helping the project grow by <a href="http://www.i2p2.i2p/getinvolved.html" target="_blank">
248          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!
249        </div>
251        <hr>
253        <div class="footnote">
254          Document last edited: June 2018.
255       </div>
257  </div>
Note: See TracBrowser for help on using the repository browser.