mirror of
https://github.com/monero-project/kovri
synced 2025-10-06 00:32:51 +02:00
9b553ae5140f619e4fb2f47f59a3c098e689a823
- To cover, veil, wrap
- A free, decentralized, anonymity technology based on I2P's open specifications
Disclaimer
- Currently Alpha software; under heavy development (and not yet integrated with monero)
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
Downloads
Releases
Alpha release coming soon
Nightly Releases (bleeding edge)
Coverage
Type | Status |
---|---|
Coverity | |
Coveralls | |
License |
Building
Dependencies and environment
Dependency | Minimum version | Optional | Arch Linux | Ubuntu/Debian | macOS (Homebrew) | FreeBSD | OpenBSD |
---|---|---|---|---|---|---|---|
git | 1.9.1 | git | git | git | git | git | |
gcc | 4.9.2 | gcc | gcc | ||||
clang | 3.5 (3.6 on FreeBSD) | clang | clang | clang (Apple) | clang36 | llvm | |
CMake | 3.5.1 | cmake | cmake | cmake | cmake | cmake | |
gmake (BSD) | 4.2.1 | gmake | gmake | ||||
Boost | 1.58 | boost | libboost-all-dev | boost | boost-libs | boost | |
OpenSSL | Always latest stable version | openssl | libssl-dev | openssl | openssl | openssl | |
Doxygen | 1.8.6 | X | doxygen | doxygen | doxygen | doxygen | doxygen |
Graphviz | 2.36 | X | graphviz | graphviz | graphviz | graphviz | graphviz |
Docker | Always latest stable version | X | See website | See website | See website | See website | See website |
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 github: do a recursive clone only
$ git clone --recursive https://github.com/monero-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
- build.getmonero.org or monero-build.i2p for detailed build information
- repo.getmonero.org or monero-repo.i2p are alternatives to GitHub 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
- Monero Mattermost
- Monero Slack (ask for an invite on IRC)
- Monero StackExchange
- Reddit /r/Kovri
- Twitter: @getkovri
- Email:
- General Purpose / Media Contact
- dev [at] getmonero.org
- All other contact
- anonimal [at] getmonero.org
- PGP Key fingerprint: 1218 6272 CD48 E253 9E2D D29B 66A7 6ECF 9144 09F1
- General Purpose / Media Contact
Donations
- Visit our Donations Page to help Kovri with your donations
Description
Languages
C++
89.7%
CMake
5.2%
Shell
2.2%
Public Key
1.6%
Makefile
0.5%
Other
0.8%