source: INSTALL.txt @ 78acf70

Last change on this file since 78acf70 was 71c4505, checked in by zzz <zzz@…>, 5 years ago

add locale note

  • Property mode set to 100644
File size: 2.3 KB
RevLine 
[4b74510]1I2P source installation instructions
2
[5568281]3Prerequisites to build from source:
[16549aa]4        Java SDK (preferably Oracle/Sun or OpenJDK) 1.7.0 or higher
[31e96b4]5          Non-linux operating systems and JVMs: See https://trac.i2p2.de/wiki/java
[16549aa]6          Certain subsystems for embedded (core, router, mstreaming, streaming, i2ptunnel) require only Java 1.6
[5568281]7        Apache Ant 1.7.0 or higher
[2c8f426e]8        The xgettext, msgfmt, and msgmerge tools installed
[71c4505]9          from the GNU gettext package http://www.gnu.org/software/gettext/
10        Build environment must use a UTF-8 locale.
[5568281]11
[4b74510]12To build and install I2P from source, you must first build
13and package up the appropriate installer by running:
14
[2c8f426e]15        ant pkg
16
17On non-x86, use one of the following instead:
18        ant installer-linux
19        ant installer-freebsd
20        ant installer-osx
21
[4b74510]22
[5568281]23
[4b74510]24This will produce a few key files:
[ce50a9ca]25* install.jar:    the GUI and console installer
26* i2pinstall.exe: the GUI and console installer wrapped for cross-platform execution
[2c8f426e]27                  (only created with ant pkg)
[ce50a9ca]28* i2pupdate.zip:  the update package
[2c8f426e]29                  (only created with ant pkg)
[4b74510]30
[ce50a9ca]31From there, you can run the headless (console mode) installer:
32  java -jar i2pinstall.exe -console
[2c8f426e]33or
34  java -jar i2pinstall.jar -console
[ce50a9ca]35
36Or run the GUI installer:
37  java -jar i2pinstall.exe
[2c8f426e]38or
39  java -jar i2pinstall.jar
40or on Windows, just double-click on i2pinstall.exe.
[ce50a9ca]41
[18e57d1]42Or move the i2pupdate.zip file into an existing installation directory and restart.
43
44To start I2P:
[16549aa]45   (*nix, BSD, Mac): sh i2prouter start
[04785e2]46   (win*): I2P.exe or i2prouter.bat
[16549aa]47   (platforms without wrapper support): sh runplain.sh
[18e57d1]48
[04785e2]49To install I2P as a system service:
[16549aa]50   (*nix, BSD, Mac) sh i2prouter install
[04785e2]51   (win*) install_i2p_service_winnt.bat
52
53To uninstall I2P as a system service:
[16549aa]54   (*nix, BSD, Mac) sh i2prouter remove
[04785e2]55   (win*) uninstall_i2p-service_winnt.bat
56
[18e57d1]57To stop I2P (gracefully):
58   lynx http://localhost:7657/summaryframe (click "Shutdown")
[16549aa]59   or (*nix, BSD, Mac) sh i2prouter graceful
[18e57d1]60
61To stop I2P immediately:
[16549aa]62   (*nix, BSD, Mac) sh i2prouter stop
[18e57d1]63
64To uninstall I2P:
65   rm -rf $I2PInstallDir ~/.i2p
[4b74510]66
67Supported JVMs:
[16549aa]68  Windows: Latest available from http://java.com/download (1.7+ supported)
69  Linux:   Latest available from http://java.com/download (1.7+ supported)
70  FreeBSD: 1.7-compatible (NIO required)
[18e57d1]71  Other operating systems and JVMs: See http://trac.i2p2.de/wiki/java
Note: See TracBrowser for help on using the repository browser.