.github | ||
android | ||
client | ||
contrib | ||
crypto | ||
daemon | ||
debian | ||
docker | ||
docs | ||
include | ||
jni | ||
libabyss | ||
libutp | ||
llarp | ||
test | ||
ui-win32 | ||
vendor | ||
win32-setup | ||
.clang-format | ||
.dir-locals.el | ||
.dockerignore | ||
.gitignore | ||
.gitlab-ci.yml | ||
CMakeLists.txt | ||
CONTRIBUTING.md | ||
doc | ||
Doxyfile | ||
LICENSE | ||
lokinet-bootstrap | ||
lokinet-bootstrap.exe | ||
Makefile | ||
module.modulemap | ||
motto.txt | ||
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)
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
$ 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:
C:\>lokinet -g && lokinet-bootstrap && lokinet
to run as relay (highly experimental, currently unsupported!):
C:\>lokinet -r -g && lokinet-bootstrap && lokinet
Usage
see the documentation on how to get started.