echelon/i2p.i2p
1
0
Fork 0
forked from I2P_Developers/i2p.i2p
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc update

Browse Source
This commit is contained in:
zzz
2011-05-22 14:31:56 +00:00
parent 45f3020924
commit 18e57d19db
4 changed files with 49 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
INSTALL-headless.txt
View File

@ -1,4 +1,4 @@
Headless I2P installation instructions Headless (console mode) I2P installation instructions
1) java -jar i2pinstall.exe -console (you've already done this) 1) java -jar i2pinstall.exe -console (you've already done this)
@ -6,9 +6,9 @@ This will run the installer in text mode, including running the postinstall.sh
script. After that, you may run 'sh i2prouter start' script. After that, you may run 'sh i2prouter start'
which will start the router and attempt to launch a browser. which will start the router and attempt to launch a browser.
If you do not have an X server running, the browser launch will probably fail, and If you do not have an X server running, the browser launch may fail, and
you may use: you may use:
lynx http://localhost:7657/index.jsp lynx http://localhost:7657/
to configure the router. to configure the router.
If you're having trouble, swing by http://forum.i2p2.de/, check the If you're having trouble, swing by http://forum.i2p2.de/, check the
@ -24,22 +24,22 @@ edit the files i2prouter (Linux) and wrapper.config (Linux and Windows)
where there are comments labeled "PORTABLE". Do this before you where there are comments labeled "PORTABLE". Do this before you
run I2P for the first time. run I2P for the first time.
To run I2P explicitly: To start I2P:
(*nix): sh i2prouter start (*nix): sh i2prouter start
(win*): I2P.exe (win*): I2P.exe
(Platforms unsupported by the wrapper - PPC, ARM, etc): sh runplain.sh (non-x86 platforms PPC, ARM, etc): sh runplain.sh
To stop the router (gracefully): To stop I2P (gracefully):
lynx http://localhost:7657/configservice.jsp ("Shutdown gracefully") lynx http://localhost:7657/summaryframe (click "Shutdown")
To stop the router (immediately): To stop I2P immediately:
sh i2prouter stop sh i2prouter stop
To uninstall I2P: To uninstall I2P:
rm -rf $i2pInstallDir rm -rf $I2PInstallDir ~/.i2p
Supported JVMs: Supported JVMs:
Windows: Latest available from http://java.sun.com/ (1.5+ supported) Windows: Latest available from http://java.com/download (1.5+ supported)
Linux: Latest available from http://java.sun.com/ (1.5+ supported) Linux: Latest available from http://java.com/download (1.5+ supported)
FreeBSD: Sun 1.5-compatible (NIO required) FreeBSD: 1.5-compatible (NIO required)
various: http://www.kaffe.org/ Sun 1.5-compatible (NIO required) Other operating systems and JVMs: See http://trac.i2p2.de/wiki/java

28
INSTALL.txt
View File

@ -1,8 +1,8 @@
I2P source installation instructions I2P source installation instructions
Prerequisites to build from source: Prerequisites to build from source:
Java SDK (preferably Sun) 1.5.0 or higher (1.6 recommended) Java SDK (preferably Oracle/Sun or OpenJDK) 1.6.0 or higher
The SDK must have Pack200 support (java.util.jar.Pack200) Non-linux operating systems and JVMs: See http://trac.i2p2.de/wiki/java
Apache Ant 1.7.0 or higher Apache Ant 1.7.0 or higher
Optional, For multilanguage support: The xgettext, msgfmt, and msgmerge tools installed Optional, For multilanguage support: The xgettext, msgfmt, and msgmerge tools installed
from the GNU gettext package http://www.gnu.org/software/gettext/ from the GNU gettext package http://www.gnu.org/software/gettext/
@ -24,10 +24,24 @@ From there, you can run the headless (console mode) installer:
Or run the GUI installer: Or run the GUI installer:
java -jar i2pinstall.exe java -jar i2pinstall.exe
Or move the update file into an existing installation directory and restart. Or move the i2pupdate.zip file into an existing installation directory and restart.
To start I2P:
(*nix): sh i2prouter start
(win*): I2P.exe
(non-x86 platforms PPC, ARM, etc): sh runplain.sh
To stop I2P (gracefully):
lynx http://localhost:7657/summaryframe (click "Shutdown")
To stop I2P immediately:
sh i2prouter stop
To uninstall I2P:
rm -rf $I2PInstallDir ~/.i2p
Supported JVMs: Supported JVMs:
Windows: Latest available from http://java.sun.com/ (1.5+ supported) Windows: Latest available from http://java.com/download (1.5+ supported)
Linux: Latest available from http://java.sun.com/ (1.5+ supported) Linux: Latest available from http://java.com/download (1.5+ supported)
FreeBSD: Sun 1.5-compatible (NIO required) FreeBSD: 1.5-compatible (NIO required)
various: http://www.kaffe.org/ Sun 1.5-compatible (NIO required) Other operating systems and JVMs: See http://trac.i2p2.de/wiki/java

16
LICENSE.txt
View File

@ -56,7 +56,7 @@ Public domain except as listed below:
Copyright (C) 2001, 2002, Free Software Foundation, Inc. Copyright (C) 2001, 2002, Free Software Foundation, Inc.
See licenses/LICENSE-LGPLv2.1.txt See licenses/LICENSE-LGPLv2.1.txt
GMP 4.1.3: GMP 4.1.3 / 4.1.4:
Copyright 1991, 1996, 1999, 2000 Free Software Foundation, Inc. Copyright 1991, 1996, 1999, 2000 Free Software Foundation, Inc.
See licenses/LICENSE-LGPLv2.1.txt See licenses/LICENSE-LGPLv2.1.txt
@ -194,6 +194,10 @@ Applications:
Copyright (c) 2003 Direct Information Pvt. Ltd. All Rights Reserved. Copyright (c) 2003 Direct Information Pvt. Ltd. All Rights Reserved.
See licenses/LICENSE-GeoIP.txt See licenses/LICENSE-GeoIP.txt
Router Console and I2PSnark themes:
"Man with hat over face" & related images licensed under a Creative Commons 2.0 license.
Original photos by Florian Kuhlmann. http://www.flickr.com/photos/floriankuhlmann/3117758155
SAM: SAM:
Public domain. Public domain.
@ -203,6 +207,8 @@ Applications:
SusiDNS: SusiDNS:
Copyright (C) 2005 <susi23@mail.i2p> Copyright (C) 2005 <susi23@mail.i2p>
See licenses/LICENSE-GPLv2.txt See licenses/LICENSE-GPLv2.txt
Uses Apache Jakarta Standard Tag Library 1.1.2:
See licenses/LICENSE-Apache2.0.txt
SusiMail: SusiMail:
Copyright (C) 2004-2005 <susi23@mail.i2p> Copyright (C) 2004-2005 <susi23@mail.i2p>
@ -227,6 +233,10 @@ distributions. See the source package for the additional license information.
Atalk: Atalk:
Public domain Public domain
BOB Demos:
Copyright (C) sponge
DWTFYWTPL
Desktopgui Desktopgui
Copyright (c) Mathias De Maré Copyright (c) Mathias De Maré
See apps/desktopgui/LICENSE See apps/desktopgui/LICENSE
@ -244,7 +254,3 @@ distributions. See the source package for the additional license information.
SAM Python Library: SAM Python Library:
Public domain. Public domain.
I2PSnark/Console themes:
"Man with hat over face" & related images licensed under a Creative Commons 2.0 license.
Original photos by Florian Kuhlmann. http://www.flickr.com/photos/floriankuhlmann/3117758155

8
README.txt
View File

@ -1,9 +1,9 @@
Prerequisites to build from source: Prerequisites to build from source:
Java SDK (preferably Sun) 1.5.0 or higher (1.6 recommended) Java SDK (preferably Oracle/Sun or OpenJDK) 1.6.0 or higher
The SDK must have Pack200 support (java.util.jar.Pack200) Non-linux operating systems and JVMs: See http://trac.i2p2.de/wiki/java
Apache Ant 1.7.0 or higher Apache Ant 1.7.0 or higher
Optional, For multilanguage support: The xgettext, msgfmt, and msgmerge tools installed Optional, For multilanguage support: The xgettext, msgfmt, and msgmerge tools installed
from the GNU gettext package http://www.gnu.org/software/gettext/ from the GNU gettext package http://www.gnu.org/software/gettext/
To build: To build:
ant pkg ant pkg
@ -11,7 +11,7 @@ To build:
See INSTALL.txt or http://www.i2p2.de/download.html for installation instructions. See INSTALL.txt or http://www.i2p2.de/download.html for installation instructions.
Documentation: Documentation:
http://www.i2p2.de/ http://www.i2p2.de/how
API: run 'ant javadoc' then start at build/javadoc/index.html API: run 'ant javadoc' then start at build/javadoc/index.html
Latest release: Latest release: