i2pd/README.md

98 lines
4.1 KiB
Markdown
Raw Normal View History

[![GitHub release](https://img.shields.io/github/release/PurpleI2P/i2pd.svg?label=latest%20release)](https://github.com/PurpleI2P/i2pd/releases/latest)
[![Snapcraft release](https://snapcraft.io/i2pd/badge.svg)](https://snapcraft.io/i2pd)
[![License](https://img.shields.io/github/license/PurpleI2P/i2pd.svg)](https://github.com/PurpleI2P/i2pd/blob/openssl/LICENSE)
[![Packaging status](https://repology.org/badge/tiny-repos/i2pd.svg)](https://repology.org/project/i2pd/versions)
2019-03-23 03:25:10 +03:00
2013-09-01 19:09:28 +04:00
i2pd
====
[Русская версия](https://github.com/PurpleI2P/i2pd_docs_ru/blob/master/README.md)
2018-01-21 19:28:16 +03:00
i2pd (I2P Daemon) is a full-featured C++ implementation of I2P client.
2013-09-01 21:49:06 +04:00
2018-01-21 19:28:16 +03:00
I2P (Invisible Internet Protocol) is a universal anonymous network layer.
2016-10-10 18:00:36 +03:00
All communications over I2P are anonymous and end-to-end encrypted, participants
2018-01-21 19:28:16 +03:00
don't reveal their real IP addresses.
2015-01-12 18:54:09 +03:00
2018-01-06 06:48:51 +03:00
I2P client is a software used for building and using anonymous I2P
networks. Such networks are commonly used for anonymous peer-to-peer
applications (filesharing, cryptocurrencies) and anonymous client-server
2018-01-21 19:28:16 +03:00
applications (websites, instant messengers, chat-servers).
2016-10-10 18:00:36 +03:00
I2P allows people from all around the world to communicate and share information
2018-01-21 19:28:16 +03:00
without restrictions.
2015-01-12 18:54:09 +03:00
2017-02-16 09:20:59 +03:00
Features
--------
2018-01-21 19:28:16 +03:00
* Distributed anonymous networking framework
* End-to-end encrypted communications
* Small footprint, simple dependencies, fast performance
* Rich set of APIs for developers of secure applications
2017-02-16 09:20:59 +03:00
Resources
---------
2016-06-16 01:11:42 +03:00
* [Website](http://i2pd.website)
* [Documentation](https://i2pd.readthedocs.io/en/latest/)
* [Wiki](https://github.com/PurpleI2P/i2pd/wiki)
* [Tickets/Issues](https://github.com/PurpleI2P/i2pd/issues)
2016-10-10 18:07:22 +03:00
* [Specifications](https://geti2p.net/spec)
2016-10-10 18:00:36 +03:00
* [Twitter](https://twitter.com/hashtag/i2pd)
2015-05-06 00:30:14 +03:00
2016-06-16 01:11:42 +03:00
Installing
----------
2015-05-06 00:30:14 +03:00
2019-03-23 03:25:10 +03:00
The easiest way to install i2pd is by using precompiled packages and binaries.
You can fetch most of them on [release](https://github.com/PurpleI2P/i2pd/releases/latest) page.
Please see [documentation](https://i2pd.readthedocs.io/en/latest/user-guide/install/) for more info.
Building
--------
2018-01-06 06:48:51 +03:00
See [documentation](https://i2pd.readthedocs.io/en/latest/) for how to build
2018-01-21 19:28:16 +03:00
i2pd from source on your OS.
2015-01-16 04:44:18 +03:00
2017-08-09 15:48:24 +03:00
Build instructions:
* [unix](https://i2pd.readthedocs.io/en/latest/devs/building/unix/)
* [windows](https://i2pd.readthedocs.io/en/latest/devs/building/windows/)
* [iOS](https://i2pd.readthedocs.io/en/latest/devs/building/ios/)
* [android](https://i2pd.readthedocs.io/en/latest/devs/building/android/)
2016-06-16 01:11:42 +03:00
**Supported systems:**
2015-01-16 04:44:18 +03:00
2019-03-23 03:25:10 +03:00
* GNU/Linux - [![Build Status](https://travis-ci.org/PurpleI2P/i2pd.svg?branch=openssl)](https://travis-ci.org/PurpleI2P/i2pd)
* CentOS / Fedora / Mageia - [![Build Status](https://copr.fedorainfracloud.org/coprs/supervillain/i2pd/package/i2pd-git/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/supervillain/i2pd/package/i2pd-git/)
* Alpine, ArchLinux, openSUSE, Gentoo, Debian, Ubuntu, etc.
2019-03-23 03:25:10 +03:00
* Windows - [![Build status](https://ci.appveyor.com/api/projects/status/1908qe4p48ff1x23?svg=true)](https://ci.appveyor.com/project/PurpleI2P/i2pd)
* Mac OS X - [![Build Status](https://travis-ci.org/PurpleI2P/i2pd.svg?branch=openssl)](https://travis-ci.org/PurpleI2P/i2pd)
* Docker image - [![Build Status](https://dockerbuildbadges.quelltext.eu/status.svg?organization=meeh&repository=i2pd)](https://hub.docker.com/r/meeh/i2pd/builds/)
* Snap - [![Snap Status](https://build.snapcraft.io/badge/PurpleI2P/i2pd-snap.svg)](https://build.snapcraft.io/user/PurpleI2P/i2pd-snap)
2016-01-31 05:04:02 +03:00
* FreeBSD
2018-01-06 06:48:51 +03:00
* Android
2016-10-13 19:56:23 +03:00
* iOS
2016-06-16 01:11:42 +03:00
Using i2pd
----------
2018-01-06 06:48:51 +03:00
See [documentation](https://i2pd.readthedocs.io/en/latest/user-guide/run/) and
2017-02-16 14:48:06 +03:00
[example config file](https://github.com/PurpleI2P/i2pd/blob/openssl/contrib/i2pd.conf).
2014-04-03 20:18:56 +04:00
2016-06-16 01:11:42 +03:00
Donations
---------
2018-01-27 03:52:11 +03:00
BTC: 3MDoGJW9TLMTCDGrR9bLgWXfm6sjmgy86f
2018-01-21 19:28:16 +03:00
LTC: LKQirrYrDeTuAPnpYq5y7LVKtywfkkHi59
2018-01-27 03:52:11 +03:00
ETH: 0x9e5bac70d20d1079ceaa111127f4fb3bccce379d
DASH: Xw8YUrQpYzP9tZBmbjqxS3M97Q7v3vJKUF
ZEC: t1cTckLuXsr1dwVrK4NDzfhehss4NvMadAJ
2018-01-21 19:28:16 +03:00
GST: GbD2JSQHBHCKLa9WTHmigJRpyFgmBj4woG
2016-06-16 01:11:42 +03:00
License
-------
2016-06-16 01:11:42 +03:00
This project is licensed under the BSD 3-clause license, which can be found in the file
2018-01-21 19:28:16 +03:00
LICENSE in the root of the project source code.