Changeset 7b379162


Ignore:
Timestamp:
Jun 9, 2018 11:54:03 AM (2 years ago)
Author:
zzz <zzz@…>
Branches:
master
Children:
2014533
Parents:
98019bb
Message:

Eepsite Help: Updates for translation (ticket #2224)
Remove dead links and commented-out text
Put each sentence on separate line
Clarify and simplify language

Location:
installer/resources/eepsite/docroot/help
Files:
1 deleted
1 edited

Legend:

Unmodified
Added
Removed
  • installer/resources/eepsite/docroot/help/index.html

    r98019bb r7b379162  
    11<!DOCTYPE html>
    22<html lang="en">
    3 
    43<head>
    54  <title>I2P Anonymous WebServer</title>
     
    87  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    98</head>
    10 
    119<body>
    1210
     
    1412
    1513   <div class="langbar">
    16       <!-- Some of these languages listed here are yet to be translated -->
    1714      <a href="index.html"><img src="lib/us.png" title="English" alt="English"></a>
    1815      <a href="index_zh.html"><img src="lib/cn.png" title="中文" alt="中文"></a>
     
    2017      <a href="index_es.html"><img src="lib/es.png" title="Español" alt="Español"></a>
    2118      <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>
    2419      <a href="index_nl.html"><img src="lib/nl.png" title="Nederlands" alt="Nederlands"></a>
    2520      <a href="index_ru.html"><img src="lib/ru.png" title="Русский" alt="Русский"></a>
     
    2924    <h1>I2P Anonymous Webserver</h1>
    3025
    31     <h2>Quick Guide to Anonymous Webserving on I2P</h2>
     26    <h2>Guide to Anonymous Webserving on I2P</h2>
    3227
    3328    <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>
    37 
    38     <p>The webserver's root directory can be found in the following locations, depending on your Operating System:
     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>The webserver's root directory can be found in the following locations, depending on your operating system:
    3934    </p>
    4035
    4136    <ul>
    4237      <li> <b>Linux</b><br>
    43         <code>~/.i2p/eepsite/docroot/</code>
     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>
    4440      </li>
    4541      <li> <b>Windows</b><br>
     
    5147    </ul>
    5248
    53     <p>In I2P, hidden services are addressed using a 'key', which is represented as a really long
    54       <a href="https://en.wikipedia.org/wiki/Base64" target="_blank">Base64</a> string. (The 'key'
    55       is somewhat analogous to an IP address, and is shown on the
    56       <a href="http://127.0.0.1:7657/i2ptunnel/edit.jsp?tunnel=3">Hidden Service Configuration page</a>).
    57     </p>
    58 
    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="http://127.0.0.1:7658/">http://127.0.0.1:7658/</a>.
     49    <p>In I2P, hidden services are addressed using a 'key', which is represented as a long Base64 string.
     50      The 'key' 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>.
     51    </p>
     52
     53    <p>The instructions below detail how to assign a name like "mysite.i2p" to your key and start up your website.
     54       You may reach your site locally via <a href="http://127.0.0.1:7658/">http://127.0.0.1:7658/</a>.
    6155    </p>
    6256
    6357    <h2>How to set up and announce your hidden service website</h2>
    6458
    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>
    72 
    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="http://127.0.0.1:7657/susidns/addressbook.jsp?book=router&amp;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="http://127.0.0.1:7657/i2ptunnel/edit.jsp?tunnel=3">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="http://127.0.0.1:7657/i2ptunnel/index.jsp">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="http://127.0.0.1:7657/index.jsp">I2P Router Console</a>. Your website is now running.
    87       </li>
    88       <li>Highlight the entire "Local destination" key on the
    89          <a href="http://127.0.0.1:7657/i2ptunnel/edit.jsp?tunnel=3">Hidden Service Configuration page</a>. and copy it
    90          for later pasting. Make sure you get the whole thing - it's over 500 characters.
     59     <p>Your website is stopped by default.
     60      After you start your I2P Webserver tunnel, it will be difficult for other people to find
     61      It can only be accessed with the long Base64 key or with the shorter Base32 address (.b32.i2p), which is a hash of the Base64 key.
     62      You could just tell people the long key or the Base32 address, but thankfully I2P has an address book and several easy ways to tell people about your website.
     63      Here are detailed instructions.
     64    </p>
     65
     66    <ul>
     67      <li>Pick a name for your website (<i>something</i>.i2p), using lower-case.
     68        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.
     69        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".
     70        This will replace the default "mysite.i2p".
     71        Also, if you would like your I2P Webserver tunnel to be automatically started when you start I2P, check the "Auto Start" box.
     72        Your website will now start every time you start your router.
     73        Be sure to click "Save".
     74      </li>
     75      <li>Click the start button for your website on the <a href="http://127.0.0.1:7657/i2ptunnel/">main Hidden Service Manager page</a>.
     76         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>.
     77         Your website is now running.
     78      </li>
     79      <li>Highlight the entire "Local destination" key on the <a href="http://127.0.0.1:7657/i2ptunnel/edit?tunnel=3">Hidden Service Configuration page</a>. and copy it for later pasting.
     80         Make sure you copy the whole thing - it's over 500 characters.
    9181      </li>
    9282      <li>Enter the name and paste in the destination key into your
    93          <a href="http://127.0.0.1:7657/susidns/addressbook.jsp?book=master">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:
     83         <a href="http://127.0.0.1:7657/susidns/addressbook?book=master">master address book</a>.
     84         Click "Add" to add the destination to your address book.
     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 following directory and  replace the index.html redirect page with your own content:
    10191        <ul>
    10292          <li> <b>Linux</b><br>
     
    113103    </ul>           
    114104
    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>!
     105    <p>Virtual folders work, so you may host files from a subdirectory without explicitly needing to provide a page  with links to files.
     106      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>.
     108      The  <a href="lib/resources">resources sub-directory</a> (containing filetype images for the directory listing)
     109      reverts to the default style.
     110      If you need a template for a basic site, feel free to borrow and adapt  <a href="pagetemplate.html">this page</a> and <a href="lib/">content</a>!
    121111    </p>
    122112
     
    129119    </ul>
    130120
    131     <h2>Register your own .I2P Domain</h2>
    132 
    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="http://127.0.0.1:7657/i2ptunnel/edit.jsp?tunnel=3">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>
     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 <a href="http://stats.i2p/ " target="_blank">stats.i2p</a> or <a href="http://no.i2p/" target="_blank">no.i2p</a>.
     124      That is, you must enter your website name and key into a web interface on one or more of these sites.
     125      Here is <a href="http://stats.i2p/i2p/addkey.html" target="_blank">the key entry form</a> at stats.i2p.
     126      Your key is the entire "Local destination" key on the <a href="http://127.0.0.1:7657/i2ptunnel/edit?tunnel=3">Hidden Service Configuration page</a>.
     127      Be sure you copy the whole thing.
     128      Don't forget to click "add a key".
     129      Check to see if it reports the key was added.
     130      Since many routers periodically get address book updates from these sites, within several hours others will be able to find your website by simply typing <i>something</i>.i2p into their browser.</p>
    142131    <h2>Adding Addressbook Subscriptions</h2>
    143132
    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="http://127.0.0.1:7657/susidns/subscriptions.jsp">Subscriptions Configuration
    146           page</a> and add a couple of these for an automatically updated list of new hosts:
     133    <p>Speaking of address book updates, this would be a good time to add some more addressbooks to your own subscription list.
     134       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:
    147135    </p>
    148136
     
    150138      <li><code>http://stats.i2p/cgi-bin/newhosts.txt</code> (<a href="http://stats.i2p/cgi-bin/newhosts.txt" target="_blank">stats.i2p</a>)
    151139      </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>-->
    154140      <li><code>http://no.i2p/export/alive-hosts.txt</code> (<a href="http://no.i2p/export/alive-hosts.txt" target="_blank">no.i2p</a>)
    155141      </li>
    156142    </ul>
    157143   
    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.
     144    <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.
     145      This will work within a few minutes of your entering the key to an address book on the same site.
     146      Test it yourself first by entering <code>http://stats.i2p/cgi-bin/jump.cgi?a=<i>something</i>.i2p</code> into your browser.
    162147      Once it's working, you can tell others to use it.
    163148    </p>
    164 <!--
    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>
    168 -->
    169 
    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:
     149
     150    <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.
     151      There are plenty of other ways to tell people. Here are a few ideas:
    173152    </p>
    174153
     
    178157      <li>Tell people about it on the #i2p or #i2p-chat channels on IRC.
    179158      </li>
    180       <li>Put it in a new post on <a href="http://syndie.i2p2.de/" 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>
    185 
    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>
     159      <li>Put it on the <a href="http://i2pwiki.i2p/index.php?title=Eepsite/Services" target="_blank">I2PWiki Eepsite Index</a>
     160      </li>
     161    </ul>
     162
     163    <p>Note that some sites recommend pasting in that really long destination key.
     164      You can if you want, but if you have successfully posted your key at an add-key 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>
    189165
    190166    <h2>Using an alternative webserver to host your site</h2>
    191167
    192     <p>This site (and the I2P router console) is running on the
    193       <a href="https://en.wikipedia.org/wiki/Jetty_(web_server)" 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 (127.0.0.1),
    196       and check the documentation to ensure your webserver isn't advertising details that may compromise your anonymity.
    197     </p>
    198 
    199      <p>To configure your webserver for use on I2P, you can either use the existing webserver tunnel and
    200        <a href="http://127.0.0.1:7657/configclients">disable the default webserver</a> from running,
    201        or create a new HTTP Server tunnel in the <a href="http://127.0.0.1:7657/i2ptunnelmgr">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 127.0.0.1 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.
     168    <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.
     169      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.
     170    </p>
     171
     172     <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>.
     173       Ensure that the listening port configured for the webserver (7658 by default) is also configured in the Hidden Services webserver settings.
     174       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.
    206175        </p>
    207176
    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:
     177        <p>Beware that a poorly configured webserver or web appplication can leak potentially compromising information such as
     178          your real IP address or server details that may reduce your anonymity or assist a hacker.
     179          We recommend using the default server unless you feel comfortable doing server administration.
     180          The following may help:
    212181        </p>
    213182
    214183        <ul>
    215            <li><a href="https://geekflare.com/apache-web-server-hardening-security/" target="_blank">Apache Web Server Hardening
    216               &amp; Security Guide</a>
     184           <li><a href="https://geekflare.com/apache-web-server-hardening-security/" target="_blank">Apache Web Server Security Guide</a>
    217185           </li>
    218            <li><a href="https://geekflare.com/nginx-webserver-security-hardening-guide/" target="_blank">Nginx Web Server Security
    219               &amp; Hardening Guide</a>
     186           <li><a href="https://geekflare.com/nginx-webserver-security-hardening-guide/" target="_blank">Nginx Web Server Security Guide</a>
    220187           </li>
    221            <li><a href="https://www.wordfence.com/learn/how-to-harden-wordpress-sites/" target="_blank">How to Harden Your WordPress
    222               Site From Attacks</a></li>
     188           <li><a href="https://www.wordfence.com/learn/how-to-harden-wordpress-sites/" target="_blank">How to Harden Your WordPress Site</a></li>
    223189        </ul>         
    224190
     
    235201                <li>Anonymously via your resident <a href="irc://127.0.0.1:6668/i2p-help">I2P IRC tunnel</a>.</li>
    236202             </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>.
     203            <li>The project forum <a href="http://i2pforum.i2p/" target="_blank">i2pforum.i2p</a>.
    239204            </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>
     205            <li><a href="http://i2pwiki.i2p/index.php?title=EepsiteHosting" target="_blank">I2PWiki Eepsite Hosting guide</a>
    242206            </li>
    243207        </ul>
    244208
    245209        <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!
     210          This page, the project website and the router console need translations!
     211          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>.
    249212        </div>
    250213       
    251214        <hr>
    252215
    253         <div class="footnote">
    254           Document last edited: June 2018.
    255        </div>
    256 
    257216  </div>
    258217</body>
Note: See TracChangeset for help on using the changeset viewer.