i2p.i2p/README.md

# I2P

This is the source code for the reference Java implementation of I2P.

Latest release: [https://geti2p.net/download](https://geti2p.net/download) 

## Installing

See [INSTALL.txt](INSTALL.txt) or [https://geti2p.net/download](https://geti2p.net/download) for installation instructions.

## Documentation

[https://geti2p.net/how](https://geti2p.net/how)

FAQ: [https://geti2p.net/faq](https://geti2p.net/faq) 

API: [http://docs.i2p-projekt.de/javadoc/](http://docs.i2p-projekt.de/javadoc/) 
or run 'ant javadoc' then start at build/javadoc/index.html

## How to contribute / Hack on I2P

Please check out [HACKING.md](docs/HACKING.md) and other documents in the docs directory.

## Building packages from source

To get development branch from source control: [https://geti2p.net/newdevelopers](https://geti2p.net/newdevelopers) 

### Prerequisites

- Java SDK (preferably Oracle or OpenJDK) 8 or higher
  - Non-linux operating systems and JVMs: See [https://trac.i2p2.de/wiki/java](https://trac.i2p2.de/wiki/java) 
  - Certain subsystems for embedded (core, router, mstreaming, streaming, i2ptunnel)
    require only Java 6
- Apache Ant 1.9.8 or higher
- The xgettext, msgfmt, and msgmerge tools installed from the GNU gettext package
 [http://www.gnu.org/software/gettext/](http://www.gnu.org/software/gettext/) 
- Build environment must use a UTF-8 locale.

### Ant build process

On x86 systems do:

    ant pkg

On non-x86, use one of the following instead:

    ant installer-linux
    ant installer-freebsd
    ant installer-osx

Run 'ant' with no arguments to see other build options.

### Gradle build process

Full builds of installers or updates are not yet possible, but the code can be
compiled with:

    ./gradlew assemble

This will download dependencies over the clearnet by default, including Gradle
itself. To download through a SOCKS proxy (e.g. Tor), add the following lines to
your `~/.gradle/gradle.properties`:

    systemProp.socksProxyHost=localhost
    systemProp.socksProxyPort=9150

### Development builds
Automatic CI builds are available at the [continuous integration](https://github.com/i2p/i2p.i2p/actions/workflows/ant.yml) page.

### Docker
For more information how to run I2P in Docker, see [Docker.md](Docker.md)
## Contact info

Need help? See the IRC channel #i2p on irc.freenode.net

Bug reports: [https://i2pgit.org/i2p-hackers/i2p.i2p/-/issues](https://i2pgit.org/i2p-hackers/i2p.i2p/-/issues) [http://git.idk.i2p/i2p-hackers/i2p.i2p/-/issues](http://git.idk.i2p/i2p-hackers/i2p.i2p/-/issues)

Contact information, security issues, press inquiries: [https://geti2p.net/en/contact](https://geti2p.net/en/contact) 

Twitter: [@i2p](https://twitter.com/i2p), [@geti2p](https://twitter.com/GetI2P)

## Licenses

See [LICENSE.txt](LICENSE.txt)
Refactor README.md 2017-07-28 00:45:08 +00:00			`# I2P`
Adding Dockerfile with support files to build a minimal docker image running i2p. 2017-01-07 13:59:26 +00:00
Refactor README.md 2017-07-28 00:45:08 +00:00			`This is the source code for the reference Java implementation of I2P.`
Adding Dockerfile with support files to build a minimal docker image running i2p. 2017-01-07 13:59:26 +00:00
turn URL's in readme into Markdown Links using URL as link text, as suggested by user gnuself on trac and approved by idk 2020-07-04 21:02:20 +00:00			`Latest release: [https://geti2p.net/download](https://geti2p.net/download)`
Adding Dockerfile with support files to build a minimal docker image running i2p. 2017-01-07 13:59:26 +00:00
Refactor README.md 2017-07-28 00:45:08 +00:00			`## Installing`
Copy README.txt contents to README.md so the github page is restored. 2017-01-09 13:54:49 +00:00
turn URL's in readme into Markdown Links using URL as link text, as suggested by user gnuself on trac and approved by idk 2020-07-04 21:02:20 +00:00			`See [INSTALL.txt](INSTALL.txt) or [https://geti2p.net/download](https://geti2p.net/download) for installation instructions.`
Copy README.txt contents to README.md so the github page is restored. 2017-01-09 13:54:49 +00:00
Refactor README.md 2017-07-28 00:45:08 +00:00			`## Documentation`
Copy README.txt contents to README.md so the github page is restored. 2017-01-09 13:54:49 +00:00
turn URL's in readme into Markdown Links using URL as link text, as suggested by user gnuself on trac and approved by idk 2020-07-04 21:02:20 +00:00			`[https://geti2p.net/how](https://geti2p.net/how)`
Copy README.txt contents to README.md so the github page is restored. 2017-01-09 13:54:49 +00:00
turn URL's in readme into Markdown Links using URL as link text, as suggested by user gnuself on trac and approved by idk 2020-07-04 21:02:20 +00:00			`FAQ: [https://geti2p.net/faq](https://geti2p.net/faq)`
Copy README.txt contents to README.md so the github page is restored. 2017-01-09 13:54:49 +00:00
turn URL's in readme into Markdown Links using URL as link text, as suggested by user gnuself on trac and approved by idk 2020-07-04 21:02:20 +00:00			`API: [http://docs.i2p-projekt.de/javadoc/](http://docs.i2p-projekt.de/javadoc/)`
Refactor README.md 2017-07-28 00:45:08 +00:00			`or run 'ant javadoc' then start at build/javadoc/index.html`
Copy README.txt contents to README.md so the github page is restored. 2017-01-09 13:54:49 +00:00
Updating README.md making contribution/hacking guide/docs more available, this is specially important for our GitHub impression which I suspect most coders will have their first meeting with I2P on. The documentation is far from done but it should make value for any new developer by this time so I've decided to push them. It losly describes our build systems, and has a monotone cheat sheet which always has an "git equalent" so it's easier to handle for people used to git. 2018-04-23 00:14:23 +00:00			`## How to contribute / Hack on I2P`

Reducing the amount of "items" in the root of the repo by moving documents into a own docs directory. 2018-04-24 00:48:08 +00:00			`Please check out [HACKING.md](docs/HACKING.md) and other documents in the docs directory.`
Updating README.md making contribution/hacking guide/docs more available, this is specially important for our GitHub impression which I suspect most coders will have their first meeting with I2P on. The documentation is far from done but it should make value for any new developer by this time so I've decided to push them. It losly describes our build systems, and has a monotone cheat sheet which always has an "git equalent" so it's easier to handle for people used to git. 2018-04-23 00:14:23 +00:00
Refactor README.md 2017-07-28 00:45:08 +00:00			`## Building packages from source`
Copy README.txt contents to README.md so the github page is restored. 2017-01-09 13:54:49 +00:00
turn URL's in readme into Markdown Links using URL as link text, as suggested by user gnuself on trac and approved by idk 2020-07-04 21:02:20 +00:00			`To get development branch from source control: [https://geti2p.net/newdevelopers](https://geti2p.net/newdevelopers)`
Copy README.txt contents to README.md so the github page is restored. 2017-01-09 13:54:49 +00:00
Refactor README.md 2017-07-28 00:45:08 +00:00			`### Prerequisites`
Copy README.txt contents to README.md so the github page is restored. 2017-01-09 13:54:49 +00:00
Build: Set javac release property (ticket #2775) Ant version 1.9.8 or higher now required Drop support for Xenial package build Fix up BOB build configuration Fix i2psnark standalone build 2020-10-07 13:33:41 +00:00			`- Java SDK (preferably Oracle or OpenJDK) 8 or higher`
turn URL's in readme into Markdown Links using URL as link text, as suggested by user gnuself on trac and approved by idk 2020-07-04 21:02:20 +00:00			`- Non-linux operating systems and JVMs: See [https://trac.i2p2.de/wiki/java](https://trac.i2p2.de/wiki/java)`
Refactor README.md 2017-07-28 00:45:08 +00:00			`- Certain subsystems for embedded (core, router, mstreaming, streaming, i2ptunnel)`
Build: Set javac release property (ticket #2775) Ant version 1.9.8 or higher now required Drop support for Xenial package build Fix up BOB build configuration Fix i2psnark standalone build 2020-10-07 13:33:41 +00:00			`require only Java 6`
			`- Apache Ant 1.9.8 or higher`
Refactor README.md 2017-07-28 00:45:08 +00:00			`- The xgettext, msgfmt, and msgmerge tools installed from the GNU gettext package`
turn URL's in readme into Markdown Links using URL as link text, as suggested by user gnuself on trac and approved by idk 2020-07-04 21:02:20 +00:00			`[http://www.gnu.org/software/gettext/](http://www.gnu.org/software/gettext/)`
Refactor README.md 2017-07-28 00:45:08 +00:00			`- Build environment must use a UTF-8 locale.`

Update README 2017-11-26 23:27:59 +00:00			`### Ant build process`
Refactor README.md 2017-07-28 00:45:08 +00:00
			`On x86 systems do:`

			`ant pkg`

			`On non-x86, use one of the following instead:`

			`ant installer-linux`
			`ant installer-freebsd`
			`ant installer-osx`

			`Run 'ant' with no arguments to see other build options.`

Update README 2017-11-26 23:27:59 +00:00			`### Gradle build process`

			`Full builds of installers or updates are not yet possible, but the code can be`
			`compiled with:`

			`./gradlew assemble`

			`This will download dependencies over the clearnet by default, including Gradle`
			`itself. To download through a SOCKS proxy (e.g. Tor), add the following lines to`
			your `~/.gradle/gradle.properties`:

			`systemProp.socksProxyHost=localhost`
			`systemProp.socksProxyPort=9150`

Use GitHub Actions to publish installer.jar on each push 2022-02-11 19:38:04 +00:00			`### Development builds`
			`Automatic CI builds are available at the [continuous integration](https://github.com/i2p/i2p.i2p/actions/workflows/ant.yml) page.`

Docker cleanup and documentation 2021-04-28 21:46:22 +00:00			`### Docker`
			`For more information how to run I2P in Docker, see [Docker.md](Docker.md)`
Refactor README.md 2017-07-28 00:45:08 +00:00			`## Contact info`

			`Need help? See the IRC channel #i2p on irc.freenode.net`

Update bug report links 2021-11-24 10:33:30 -05:00			`Bug reports: [https://i2pgit.org/i2p-hackers/i2p.i2p/-/issues](https://i2pgit.org/i2p-hackers/i2p.i2p/-/issues) [http://git.idk.i2p/i2p-hackers/i2p.i2p/-/issues](http://git.idk.i2p/i2p-hackers/i2p.i2p/-/issues)`
Refactor README.md 2017-07-28 00:45:08 +00:00
turn URL's in readme into Markdown Links using URL as link text, as suggested by user gnuself on trac and approved by idk 2020-07-04 21:02:20 +00:00			`Contact information, security issues, press inquiries: [https://geti2p.net/en/contact](https://geti2p.net/en/contact)`
Refactor README.md 2017-07-28 00:45:08 +00:00
turn URL's in readme into Markdown Links using URL as link text, as suggested by user gnuself on trac and approved by idk 2020-07-04 21:02:20 +00:00			`Twitter: [@i2p](https://twitter.com/i2p), [@geti2p](https://twitter.com/GetI2P)`
Refactor README.md 2017-07-28 00:45:08 +00:00
			`## Licenses`

turn URL's in readme into Markdown Links using URL as link text, as suggested by user gnuself on trac and approved by idk 2020-07-04 21:02:20 +00:00			`See [LICENSE.txt](LICENSE.txt)`
Adding Dockerfile with support files to build a minimal docker image running i2p. 2017-01-07 13:59:26 +00:00