I2P Address: [http://git.idk.i2p]

Skip to content
Snippets Groups Projects
Commit 4e90ca0b authored by jrandom's avatar jrandom Committed by zzz
Browse files

* revamped (rewrote, htmlized) readme

* wrote basic license stuff
parent 8c4c72c8
No related branches found
No related tags found
No related merge requests found
...@@ -247,7 +247,7 @@ ...@@ -247,7 +247,7 @@
<fileset dir="installer/lib/wrapper/win32/" /> <fileset dir="installer/lib/wrapper/win32/" />
</copy> </copy>
<copy file="hosts.txt" todir="pkg-temp/" /> <copy file="hosts.txt" todir="pkg-temp/" />
<copy file="readme.txt" todir="pkg-temp/" /> <copy file="readme.html" todir="pkg-temp/" />
</target> </target>
<target name="tarball" depends="preppkg"> <target name="tarball" depends="preppkg">
<tar compression="bzip2" destfile="i2p.tar.bz2"> <tar compression="bzip2" destfile="i2p.tar.bz2">
......
...@@ -4,12 +4,32 @@ free (adj.) - unencumbered; not under the control ...@@ -4,12 +4,32 @@ free (adj.) - unencumbered; not under the control
of others of others
This software is released into the public domain This software is released into the public domain
by the I2P Project with no warranty of any kind, by the I2P team with no warranty of any kind,
either expressed or implied. It probably won't either expressed or implied. It probably won't
make your computer catch on fire, or eat your make your computer catch on fire, or eat your
children, but it might. Use at your own risk. children, but it might. Use at your own risk.
I2P makes use of the following non-public domain The base I2P router and SDK make use of the
software under various restrictive licenses: following non-public domain code:
(Blah blah...) * TheCrypto's cryptographic routines (BSD)
* Cryptix's AES routines (Cryptix license)
* Adam Buckley's SNTP routines (BSD)
Also included in this distribution are a bunch
of third party client applications, all with
their own dependencies. Please see our license
policy page for details:
http://www.i2p.net/licenses
One of the bundled client apps (routerconsole)
requires us to say:
This product includes software developed by
the Apache Software Foundation
(http://www.apache.org/)
Another (I2PTunnel) is GPL licensed.
For source, please see:
http://www.i2p.net/download
or http://www.i2p.net/cvs
\ No newline at end of file
<h1>Congratulations on getting I2P installed!</h1>
<p>Next up you'll need to go into the <a href="config.jsp">configuration page</a>
and provide some info (such as your IP address, etc). You will also want to
seed your router on that page as well, and may want to consider reviewing some
of the other configuration pages. Alternately, you can update the "router.config"
file in your I2P installation directory, which is checked for updates periodically.</p>
<p>After your router has been configured and you have reseeded, within a few minutes
(3-5), you should see the number of active peers increase. If it doesn't, you may
want to verify that the hostname and port number specified on the configuration page
are correct and reachable from the outside world.</p>
<p>For help, you may want to review the information on the <a href="http://www.i2p.net/">I2P website</a>,
post up messages to the <a href="http://forum.i2p.net/">I2P discussion forum</a>, or swing by #i2p or
#i2p-chat on IRC at <a href="irc://irc.freenode.net/#i2p">irc.freenode.net</a>,
<a href="http://www.invisiblechat.com/">invisiblechat/IIP</a>, or irc.duck.i2p (they're all
linked together).</p>
<h2>Want I2P to run automatically?</h2>
<p>With the I2P install we've bundled some scripts and code (from the cool folks at
<a href="http://wrapper.tanukisoftware.org/doc/english/">tanukisoftware</a>) to let you
run I2P as a service on windows machines (a daemon, for you *nix geeks). To install it,
just run install_i2p_service_winnt.bat (or install_i2p_service_unix, as root). To uninstall
it, run uninstall_i2p_service_winnt.bat (or uninstall_i2p_service_unix, as root). To uninstall
I2P altogether, simply wipe the I2P installation directory.</p>
<h2>What next?</h2>
<p>By default, I2P comes bundled with the <a href="http://www.i2p.net/i2ptunnel">I2PTunnel</a>
application configured with an <b>HTTP proxy</b> listening on <b>port 4444</b> and an
<b>IRC proxy</b> listening on <b>port 6668</b>.</p>
<p>The HTTP proxy lets you access "eepsites" - anonymously hosted websites -
routing your requests and their responses over I2P. There are also a few "outproxies" -
gateways onto the normal internet - through which you can browse normal websites
anonymously. Once you've configured your browser to use the proxy, you should be able
to reach some of the following sites:</p>
<ul>
<li><a href="http://duck.i2p/">duck.i2p</a>: duck's eepsite, with links to other active sites</li>
<li><a href="http://ugha.i2p/">ugha.i2p</a>: ugha's eepsite, a wiki that anyone can edit, and lots of links</li>
<li><a href="http://forum.i2p/">forum.i2p</a>: an anonymous gateway to <a href="http://forum.i2p.net/">forum.i2p.net</a></li>
<li><a href="http://fproxy.i2p/">fproxy.i2p</a> and <a href="http://fproxy2.i2p/">fproxy2.i2p</a>:
public gateways into two different freenet nodes</li>
</ul>
<p>The IRC proxy is a gateway to duck's anonymously hosted IRC server
"irc.duck.i2p". You can treat it like any other IRC server - fire up your IRC client and
connect to the server at localhost:6668 and join us on #i2p or #i2p-chat! DCC doesn't
work at the moment though.</p>
<p>By default, those two proxies listen only on the local interface, which means you
cannot access them from other machines on your network (and neither can random strangers :)
If you want to make them accessible, or want to update them through some other way, go to
the <a href="/i2ptunnel/" target="_blank">I2PTunnel configuration interface</a> and edit them accordingly.
You can also go to that page if you want to add a new tunnel, such as if you want to run
your own eepsite.</p>
<p><b>As a note, you can change this page by editing the file "readme.html"</b></p>
\ No newline at end of file
$Id: readme.txt,v 1.2 2004/06/09 09:27:51 duck Exp $
I2P Router 0.3
You have installed a development release of I2P - a variable latency secure
and anonymous communication network. I2P is NOT a filesharing network, or an
email network, or a publishing network - it is simply an anonymous communication
layer - kind of an anonymous IP. This installation includes an application
called "I2PTunnel", which allows normal TCP/IP applications to run over I2P,
offering functionality such as access to anonymous irc servers, anonymous
websites ("eepsites"), etc.
Since this is a *development* release, I2P should not be depended upon for
anonymity or security. The network is very small, and there are certainly bugs
and suboptimal features. Participating in the network at this time should be
for exploration and to evaluate I2P's functionality and suitability for your
later needs. Once I2P 1.0 is out, wider adoption may be appropriate, but until
that time, we do want to keep the I2P community small, since you are all part of
the development team.
=== How to get started
Like a TCP/IP stack, installing the I2P "router" itself doesn't really do much.
You can fire it up with the script startRouter.sh (or startRouter.bat on
windows), and its management console can be seen via http://localhost:7655/
Once your router has started up, it may take a few minutes to get integrated
with the network (you'll see a few TCP connections listed on the management
console). At that point, you can use any of the various proxies:
* eepProxy: this proxy is launched automatically 2 minutes after you start
your router, it starts an HTTP proxy to access eepsites. Set your browser's
HTTP proxy to localhost:4444 and you can browse various anonymously hosted
sites, ala http://duck.i2p/. In addition, the default proxy is set up to
tunnel any HTTP requests that don't point at an eepsite (e.g. http://i2p.net/)
through I2P to an outbound squid proxy - with this, you can browse the web
anonymously.
* ircProxy: this proxy is also started automatically 2 minutes after the router
is started, listening on port 6668. If you fire up your favorite irc client
to irc://localhost:6668/#i2p you'll be logged on to irc.duck.i2p, an
anonymously hosted IRC server (which is hooked up to the IIP server and has
bridges to a few channels on irc.freenode.net)
=== Problems accessing eepsites or servers
I2P is not a distributed data store (ala freenet / mnet / etc) - sites are only
reachable when the host serving that data is up (and their router is running).
If you persistently can't reach the irc server, the squid proxy, or some common
eepsites, check your management console (http://localhost:7655/) and make sure
you have TCP connections. If you don't have any, make sure your firewall / NAT
allows inbound access to your I2P port (which you specified during
installation). If thats fine, but you only see one routerInfo-*.dat file
underneath your netDb/ directory, run the reseed script to pull some new peer
references (it contacts http://dev.i2p.net/i2pdb/ and downloads those files.
alternately, you can get routerInfo files from any of your friends, etc)
If you still have problems, get in touch with the I2P team (contact info below)
=== Resources / contact info
Our website can be found at http://www.i2p.net/
The development and user community hangs out on a few different linked irc
chats - IIP's #i2p, freenode.net's #i2p, and the in-I2P irc network's #i2p
(the irc.duck.i2p server). All of those channels are hooked together, so
join whichever one meets your needs.
There is also a relatively low traffic mailing list:
http://dev.i2p.net/mailman/listinfo/i2p with archives at
http://dev.i2p.net/pipermail/i2p/
The source can be retrieved from http://i2p.net/i2p/ as well as the latest
binary distributions.
You can pull the latest code via cvs:
cvs -d :pserver:anoncvs@cvs.i2p.net:/cvsroot login
cvs -d :pserver:anoncvs@cvs.i2p.net:/cvsroot co i2p
The password is "anoncvs".
=== Acknowledgements
We are a small group of volunteers spread around several continents, working to
advance different aspects of the project and discussing the design of the
network. For a current list of team members, please see
http://www.i2p.net/team
=== Licenses
All code included here is released under an open source license. To review
the I2P license policy, please see http://www.i2p.net/licenses
If there is any confusion, please see the source code or contact the
developers on the i2p list.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment