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

Last change on this file since b1541db was b1541db, checked in by zzz <zzz@…>, 3 years ago

Eepsite help: more edits

  • Property mode set to 100644
File size: 13.3 KB
Line 
1<!DOCTYPE html>
2<html lang="en">
3<head>
4  <title>I2P Anonymous WebServer</title>
5  <link rel="shortcut icon" href="favicon.ico" />
6  <link rel="stylesheet" type="text/css" href="lib/eepsite.css" />
7  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8</head>
9<body>
10
11   <div class="main">
12
13   <div class="langbar">
14      <a href="index.html"><img src="lib/us.png" title="English" alt="English"></a>
15      <a href="index_zh.html"><img src="lib/cn.png" title="中文" alt="中文"></a>
16      <a href="index_de.html"><img src="lib/de.png" title="Deutsch" alt="Deutsch"></a>
17      <a href="index_es.html"><img src="lib/es.png" title="Español" alt="Español"></a>
18      <a href="index_fr.html"><img src="lib/fr.png" title="Français" alt="Français"></a>
19      <a href="index_nl.html"><img src="lib/nl.png" title="Nederlands" alt="Nederlands"></a>
20      <a href="index_ru.html"><img src="lib/ru.png" title="Русский" alt="Русский"></a>
21      <a href="index_sv.html"><img src="lib/se.png" title="Svenska" alt="Svenska"></a>
22    </div>
23
24    <h1>I2P Anonymous Webserver</h1>
25
26    <h2>Guide to Anonymous Webserving on I2P</h2>
27
28    <p>
29      This is your own anonymous I2P webserver (traditionally referred to as an <i>eepsite</i>).
30      To serve your own content, simply edit the files in the webserver's root directory and the site will be public once you follow the instructions below.
31    </p>
32
33    <p id="dir">The webserver's root directory can be found in one of the following locations, depending on your operating system:
34    </p>
35
36    <ul>
37      <li><b>Linux</b><br>
38        Standard install: <code>~/.i2p/eepsite/docroot/</code><br>
39        Package install, running as a service: <code>/var/lib/i2p/i2p-config/eepsite/docroot/</code>
40      </li>
41      <li><b>Windows</b><br>
42        <code>%APPDATA%\I2P\eepsite\docroot\</code>
43      </li>       
44      <li><b>Mac</b><br>
45        <code>/Users/(user)/Library/Application Support/i2p</code>
46      </li>
47    </ul>
48
49    <p>In I2P, hidden services are addressed using a Base32 address ending in ".b32.i2p", or a Destination represented as a long Base64 string.
50      The Base32 address may be used as a hostname, until you assign a register a name following the instructions below.
51      The Destination is somewhat like an IP address, and is shown on the <a href="http://127.0.0.1:7657/i2ptunnel/edit?tunnel=3">Hidden Service Configuration page</a>.
52    </p>
53
54    <p>The instructions below detail how to assign a name like "mysite.i2p" to your website and enable access by others.
55       You may reach your site locally via <a href="http://127.0.0.1:7658/">http://127.0.0.1:7658/</a>.
56    </p>
57
58    <h2>How to set up and announce your hidden service</h2>
59
60     <p>Your webserver is running by default, but is not accessible by others until you start the hidden service tunnel.
61      After you start your I2P Webserver tunnel, it will be difficult for other people to find
62      It can only be accessed with the long Destination or with the shorter Base32 address (.b32.i2p), which is a hash of the Destination.
63      You could just tell people the Destnation or the Base32 address, but thankfully I2P has an address book and several easy ways to tell people about your website.
64      Here are detailed instructions.
65    </p>
66
67    <ul>
68      <li>Pick a name for your website (<i>something</i>.i2p), using lower-case.
69        You may wish to check first in your own router's <a href="http://127.0.0.1:7657/susidns/addressbook?book=router&amp;filter=none">address book</a> to see if your name is already taken.
70        Enter the new name for your website on the <a href="http://127.0.0.1:7657/i2ptunnel/edit?tunnel=3">Hidden Service Configuration page</a> where it says "Website name".
71        This will replace the default "mysite.i2p".
72        Also, if you would like your I2P Webserver tunnel to be automatically started when you start I2P, check the "Auto Start" box.
73        Your website will now start every time you start your router.
74        Be sure to click "Save".
75      </li>
76      <li>Click the start button for your webserver tunnel on the <a href="http://127.0.0.1:7657/i2ptunnel/">main Hidden Service Manager page</a>.
77         You should now see it listed under "Local Tunnels" on the left side of the <a href="http://127.0.0.1:7657/">I2P Router Console</a>.
78         Your website is now running.
79      </li>
80      <li>Highlight and copy the entire Local destination on the <a href="http://127.0.0.1:7657/i2ptunnel/edit?tunnel=3">Hidden Service Configuration page</a>.
81         Make sure you copy the whole thing, it is over 500 characters.
82      </li>
83      <li>Enter the name and paste the destination into your <a href="http://127.0.0.1:7657/susidns/addressbook?book=router&amp;filter=none">address book</a>.
84         Click "Add" to save the new entry.
85      </li>
86      <li>In your browser, enter in your website name (<i>something</i>.i2p) and you should be right back here.
87          Hopefully it worked!
88      </li>
89      <li>Before you tell the world about your new website, you should add some content.
90          Go to the server's root directory <a href="#dir">listed above</a> and replace the index.html redirect page with your own content.
91      </li>
92    </ul>           
93
94    <p>Directory listings are enabled, so you may host files from a subdirectory without providing a page with links to the files.
95      You may change the appearance of the directory by supplying an edited <a href="lib/jetty-dir.css">jetty-dir.css</a> file for each directory.
96      The <a href="lib/">lib subdirectory</a> demonstrates a custom style.
97      The <a href="lib/resources">resources subdirectory</a> demonstrates the default style.
98      If you need a template for a basic site, feel free to adapt <a href="pagetemplate.html">this page</a> and <a href="lib/">associated content</a>.
99    </p>
100
101    <p>If you're returned to this page after editing the content, try clearing your browser's web cache:</p>
102
103    <ul>
104      <li><b>Firefox:</b> Preferences ➜ Advanced ➜ Network ➜ Cached Web Content ➜ Clear Now</li>
105      <li><b>Chrome/Chromium:</b> Settings ➜ Advanced Settings ➜ Privacy ➜ Clear browsing data</li>
106      <li><b>Opera:</b> Settings ➜ Privacy ➜ Clear browsing data</li>
107    </ul>
108
109    <h2>Register your own I2P Domain</h2>
110
111    <p>Now it is time to add your website to an I2P address book hosted by a site such as <a href="http://stats.i2p/ " target="_blank">stats.i2p</a> or <a href="http://no.i2p/" target="_blank">no.i2p</a>.
112      You must enter your website name and Destination (or Registration Authentication string) on one or more of these sites.
113    </p><p>Some registration sites require the Destination.
114      If so, highlight and copy the entire Local destination on the <a href="http://127.0.0.1:7657/i2ptunnel/edit?tunnel=3">Hidden Service Configuration page</a>.
115      Make sure you copy the whole thing, it is over 500 characters.
116    </p><p>Some registration sites, including <a href="http://stats.i2p/i2p/addkey.html" target="_blank">stats.i2p</a>, require the Registration Authentication string.
117      It is found on the <a href="http://127.0.0.1:7657/i2ptunnel/register?tunnel=3">Registration Authentication page</a> linked from the <a href="http://127.0.0.1:7657/i2ptunnel/edit?tunnel=3">Hidden Service configuration page</a>.
118      Copy the entire authentication string and paste it on the registration page.
119      Make sure you copy the whole thing, it is over 500 characters.
120      Describe your site briefly if the site requests this information.
121      If your site is a HTTP service, leave the checkbox selected; if not, unselect it.
122    </p><p>For all registration sites, read through the Terms of Service carefully.
123      Click the "Submit" button.
124      Verify the submission was successful.
125      Since many routers periodically get address book updates from these sites, within several hours others will be able to find your website by simply entering your hostname in their browser.</p>
126
127    <h2>Adding Addressbook Subscriptions</h2>
128
129    <p>Speaking of address book updates, this would be a good time to add some more addressbooks to your own subscription list.
130       Go to your <a href="http://127.0.0.1:7657/susidns/subscriptions">Subscriptions Configuration page</a> and add one or more for an automatically updated list of new hosts:
131    </p>
132
133    <ul>
134      <li><code>http://stats.i2p/cgi-bin/newhosts.txt</code> (<a href="http://stats.i2p/cgi-bin/newhosts.txt" target="_blank">stats.i2p</a>)
135      </li>
136      <li><code>http://no.i2p/export/alive-hosts.txt</code> (<a href="http://no.i2p/export/alive-hosts.txt" target="_blank">no.i2p</a>)
137      </li>
138    </ul>
139   
140    <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 service.
141      This will work within a few minutes of your registering your hostname on the same site.
142      Test it yourself first by entering <code>http://stats.i2p/cgi-bin/jump.cgi?a=<i>something</i>.i2p</code> into your browser.
143      Once it is working, you can tell others to use it.
144    </p>
145
146    <p>Some people check website lists such as <a href="http://identiguy.i2p/" target="_blank">Identiguy's eepsite status list</a> or <a href="http://no.i2p/browse/" target="_blank">no.i2p's active host list</a> for new eepsites, so your site may start getting some traffic.
147      There are plenty of other ways to tell people. Here are a few ideas:
148    </p>
149
150    <ul>
151      <li>Post a message on the <a href="http://i2pforum.i2p/" target="_blank">I2P forum</a> telling everyone about your new I2P website!
152      </li>
153      <li>Tell people about it on the #i2p or #i2p-chat channels on IRC.
154      </li>
155      <li>Put it on the <a href="http://i2pwiki.i2p/index.php?title=Eepsite/Services" target="_blank">I2PWiki Eepsite Index</a>
156      </li>
157    </ul>
158
159    <p>Note that some sites recommend pasting in that really long destination.
160      You can if you want, but if you have successfully registered your hostname on a registration service, tested it using a jump service, and waited 24 hours for the address book update to propagate to others, that shouldn't be necessary.</p>
161
162    <h2>Using an alternative webserver to host your site</h2>
163
164    <p>This site (and the I2P router console) is running on the <a href="https://en.wikipedia.org/wiki/Jetty_(web_server)" target="_blank">Jetty webserver</a>, but you may wish to use a different webserver to host your content.
165      To maintain anonymity, be sure that your webserver is configured to only allow connections from localhost (127.0.0.1), and check the documentation to ensure your webserver isn't advertising details that may compromise your anonymity.
166    </p>
167
168     <p>To configure your webserver for use on I2P, you may either use the existing webserver tunnel and <a href="http://127.0.0.1:7657/configclients">disable the default webserver</a> from running, or create a new HTTP Server tunnel in the <a href="http://127.0.0.1:7657/i2ptunnelmgr">Hidden Services Manager</a>.
169       Ensure that the listening port configured for the webserver (7658 by default) is also configured in the Hidden Services settings.
170       For example, if your webserver is listening 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 for the service is also configured to port 80.
171        </p> 
172
173        <p>Beware that a poorly configured webserver or web appplication can leak potentially compromising information such as
174          your real IP address or server details that may reduce your anonymity or assist a hacker.
175          We recommend using the default server unless you feel comfortable doing server administration.
176          Please ensure your web server is secure prior to placing it online.
177          There are plenty of guides online, for example if you search for "nginx security hardening guide" you will find a number of guides that have good recommendations.
178        </p> 
179
180        <p>There is one important issue with the Apache web server.
181          The <code>mod_status</code> and <code>mod_info</code> Apache modules are enabled by default on some operating systems.
182          These modules expose internal data which can lead to serious compromise of anonymity when used on an anonymous network.
183          Removing the lines in the configuration file where these modules are loaded is the easiest way to prevent these issues.
184        </p>
185
186    <h2>Further Assistance</h2>
187
188        <p>If you have any questions, the following places are available for support:
189        </p>
190
191        <ul>
192          <li>Our IRC support channel:
193             <ul>
194                <li><a href="irc://irc.freenode.net/i2p">#i2p on Freenode</a>
195                </li>
196                <li>Anonymously using your local <a href="irc://127.0.0.1:6668/i2p">I2P IRC tunnel</a>.</li>
197             </ul>
198            <li>The project forum <a href="http://i2pforum.i2p/" target="_blank">i2pforum.i2p</a>.
199            </li>
200            <li><a href="http://i2pwiki.i2p/index.php?title=EepsiteHosting" target="_blank">I2PWiki Eepsite Hosting guide</a>
201            </li>
202        </ul>
203
204        <hr>
205        <div class="notify">
206          This page, the project website and the router console need translations!
207          Please help the project grow by <a href="http://i2p-projekt.i2p/getinvolved.html" target="_blank"> getting involved</a> or <a href="http://i2p-projekt.i2p/en/get-involved/guides/new-translators" target="_blank">translating</a>.
208        </div>
209        <hr>
210
211  </div>
212</body>
213</html>
Note: See TracBrowser for help on using the repository browser.