Giter Club home page Giter Club logo

i2pcpp's Introduction

i2pcpp

i2pcpp is an I2P router written in C++11 by orion. It is targeted for the advanced I2P user demographic.

Features

Currently the router is able to forward traffic between peers. It is unable to do much more at this time.

Building

Requirements

To compile, you will require the following components:

clang 3.3+ is the only officially supported compiler, but there is an honest effort to be compatible with g++. i2pcpp will always work on the latest release version of FreeBSD.

Using cmake

i2pcpp should be built out of source:

mkdir build; cd build

Variables

The following cmake variables are recognized:

  • CMAKE_BUILD_TYPE (Debug, Release, or MinSizeRel)
  • CMAKE_C_COMPILER
  • CMAKE_CXX_COMPILER
  • BOOST_INCLUDEDIR
  • BOOST_LIBRARYDIR
  • BOTAN_INCLUDEDIR
  • BOTAN_LIBRARYDIR
  • SQLITE3_INCLUDEDIR
  • SQLITE3_LIBRARYDIR

Below is an example of how to invoke cmake from within your build directory:

cmake .. -DCMAKE_BUILD_TYPE=Debug

Specify additional variables as necessary.

Making

On most systems you simply need to execute make and everything will be built. On FreeBSD you must use gmake.

Output files

One binary, i2p will be produced. If you are building unit tests, a second binary testi2p will be produced.

First time setup

Database initialization

i2pcpp uses a sqlite database to store RouterInfo, profiles, and configuration data. When running i2pcpp for the first time, this database must be generated:

./i2p --init

This command also generates the proper crypto keys and saves them in the database.

The database will be named i2p.db by default. If you want to override the default database, you can specify the following argument with any command:

./i2p --db=somefile.db

Note that if you do not use the default database file, you must specify this argument for all commands.

Configuration

Configuration settings are stored in the database. Individual settings are read and written in this way:

./i2p --get key ./i2p --set key value

The following keys are supported:

  • ssu_bind ip (IP to bind to)
  • ssu_bind_port (Port to bind to)
  • ssu_external_ip (IP to advertise)
  • ssu_external_port (Port to advertise)
  • min_peers (Minimum number of peers to maintain)
  • control_server (1 to enable, 0 to disable)
  • control_server_ip (IP for the control server to bind to)
  • control_server_port (Port for the control server to bind to)

Router Info files

Router Info files generated by the Java i2p client can be imported in to i2pcpp to seed your database:

./i2p --import someRouterInfoFile.dat

These files are usually located in ~/.i2p/netDb/. To recursively import the entire netDb directory, use the '--importdir' argument:

./i2p --importdir /home/you/.i2p/netDb

You can export your own personal Router Info file:

./i2p --export myRouterInfoFile.dat

This allows you to share it with others.

To wipe the database clean of all profiles and routers, use the '--wipe' option:

./i2p --wipe

This will not clear your configuration settings or crypto keys.

Running

By default, i2pcpp prints logging output to stderr. To redirect this to a log file, use the --log (or -l) options:

./i2p -l

This option takes an optional argument to specify the filename to log to. If no argument is provided, the log file i2p.log will be used.

Contact

The author hangs out in #i2p-dev on the irc2p network under the nickname orion. A GPG key is included in the doc/ directory which can be used to send private messages and verify commits.

GPG fingerprint: 51F4 F421 CF7C 3CA0 26A4 24CD 83BA E5AA F4D1 5FC8

i2pcpp's People

Contributors

einmbyte avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.