d67eb40697 | 6 years ago | |
---|---|---|
.github | 6 years ago | |
android | 6 years ago | |
client | 6 years ago | |
contrib | 6 years ago | |
crypto | 6 years ago | |
daemon | 6 years ago | |
debian | 6 years ago | |
docker | 6 years ago | |
docs | 6 years ago | |
include | 6 years ago | |
jni | 6 years ago | |
libabyss | 6 years ago | |
libutp | 6 years ago | |
llarp | 6 years ago | |
test | 6 years ago | |
ui-win32 | 6 years ago | |
vendor | 6 years ago | |
win32-setup | 6 years ago | |
.clang-format | 6 years ago | |
.dir-locals.el | 7 years ago | |
.dockerignore | 6 years ago | |
.gitignore | 6 years ago | |
.gitlab-ci.yml | 6 years ago | |
CMakeLists.txt | 6 years ago | |
CONTRIBUTING.md | 6 years ago | |
Doxyfile | 6 years ago | |
LICENSE | 6 years ago | |
Makefile | 6 years ago | |
doc | 6 years ago | |
lokinet-bootstrap | 6 years ago | |
lokinet-bootstrap-testnet.exe | 6 years ago | |
lokinet-bootstrap.exe | 6 years ago | |
module.modulemap | 6 years ago | |
motto.txt | 6 years ago | |
readme.md | 6 years ago | |
run-lokinet.bat | 6 years ago | |
testnet_readme.md | 6 years ago |
readme.md
LokiNet
LokiNet is the reference implementation of LLARP (low latency anonymous routing protocol), a layer 3 onion routing protocol.
You can learn more about the high level design of LLARP here
And you can read the LLARP protocol specification here
Building
Build requirements:
- GNU Make
- CMake
- C++ 17 capable C++ compiler
- rapidjson (if enabling jsonrpc server)
- gcovr (if generating test coverage with gcc)
Linux
build:
$ sudo apt install build-essential cmake git libcap-dev wget rapidjson-dev
$ git clone https://github.com/loki-project/loki-network
$ cd loki-network
$ make -j8
install:
$ sudo make install
FreeBSD
build:
$ pkg install wget cmake git
$ git clone https://github.com/loki-project/loki-network
$ cd loki-network
$ gmake -j8
install (root):
# gmake install
Windows
build (where $ARCH
is your platform - i686
or x86_64
):
$ pacman -Sy base-devel mingw-w64-$ARCH-toolchain git libtool autoconf mingw-w64-$ARCH-cmake mingw-w64-$ARCH-rapidjson
$ git clone https://github.com/loki-project/loki-network.git
$ cd loki-network
$ mkdir -p build; cd build
$ cmake .. -DCMAKE_BUILD_TYPE=[Debug|Release] -DSTATIC_LINK=ON -DCMAKE_C_COMPILER=gcc -DCMAKE_CXX_COMPILER=g++ -DDNS_PORT=53 -G 'Unix Makefiles'
install (elevated) to $PROGRAMFILES/lokinet
or $ProgramFiles(x86)/lokinet
:
$ make install
if cross-compiling, install mingw-w64 from your distro's package manager, or build from source, then:
$ mkdir -p build; cd build
$ export COMPILER=clang # if using clang for windows
$ cmake .. -DCMAKE_BUILD_TYPE=[Debug|Release] -DSTATIC_LINK=ON -DCMAKE_CROSSCOMPILING=ON -DDNS_PORT=53 -DCMAKE_TOOLCHAIN_FILE=../contrib/cross/mingw[32].cmake
this will create a static binary that can be installed anywhere, with no other dependency other than libc (minimum v6.1)
Running on Linux/UNIX/BSD
DO NOT RUN AS ROOT, run as normal user.
to run as client:
$ lokinet -g
$ lokinet-bootstrap
$ lokinet
to run as relay:
$ lokinet -r -g
$ lokinet-bootstrap
$ lokinet
Running on Windows
DO NOT RUN AS ELEVATED USER, run as normal user.
to run as client, run the run-lokinet.bat
batch file as your normal user.
Usage
see the documentation on how to get started.