kovri

1. To cover, veil, wrap
2. A free, decentralized, anonymity technology based on I2P's open specifications

Disclaimer

• Currently Alpha software; under heavy development

Library APIs

• Kovri API hooks are best used through the Sekreta API. Also see Monero for usage examples.

Quickstart

• Want pre-built binaries? Download below
• Want to build and install yourself? Build instructions below

Multilingual README

This page is also available in the following languages

• Italiano
• Espaol
• P
• Franais
• Deutsch
• Dansk

Downloads

Releases

Soon[tm]

Nightly Releases (bleeding edge)

Soon[tm]

Coverage

Type	Status
Coverity
Codecov
License

Building

Dependencies and environment

Windows (MSYS2/MinGW-64)

• Download the MSYS2 installer, 64-bit or 32-bit as needed
• Use the shortcut associated with your architecture to launch the MSYS2 environment. On 64-bit systems that would be the MinGW-w64 Win64 Shell shortcut. Note: if you are running 64-bit Windows, you'll have both 64-bit and 32-bit environments
• Update the packages in your MSYS2 install:

$ pacman -Sy
$ pacman -Su --ignoregroup base
$ pacman -Syu

Install packages

Note: For i686 builds, replace mingw-w64-x86_64 with mingw-w64-i686

$ pacman -S make mingw-w64-x86_64-cmake mingw-w64-x86_64-gcc mingw-w64-x86_64-boost mingw-w64-x86_64-openssl

Optional:

$ pacman -S mingw-w64-x86_64-doxygen mingw-w64-x86_64-graphviz

Make and install

Do not use the zip file from gitlab: do a recursive clone only

$ git clone --recursive https://gitlab.com/kovri-project/kovri
$ cd kovri && make release  # see the Makefile for all build options
$ make install

• End-users MUST run make install for new installations
• Developers SHOULD run make install after a fresh build

Docker

Or build locally with Docker

$ docker build -t kovri:latest .

Documentation and Development

• A User Guide is available for all users
• A Developer Guide is available for developers (please read before opening a pull request)
• More documentation can be found in your language of choice within the kovri-docs repository
• Moneropedia is recommended for all users and developers
• Forum Funding System to get funded for your work, submit a proposal
• repo.getmonero.org or monero-repo.i2p are alternatives to GitLab for non-push repository access
• See also kovri-site and monero/kovri meta

Vulnerability Response

• Our Vulnerability Response Process encourages responsible disclosure
• We are also available via HackerOne

Contact and Support

• IRC: Freenode | Irc2P with Kovri
  • #kovri | Community & Support Channel
  • #kovri-dev | Development Channel
• Twitter: @getkovri
• Email:
  • dev [at] kovri.io
• Kovri Slack (invitation needed via Email or IRC)
• Monero Mattermost
• Monero StackExchange
• Reddit /r/Kovri

Donations

• Visit our Donations Page to help Kovri with your donations