2018-06-16 14:31:48 +02:00
# LokiNet
2017-09-22 23:06:48 +02:00
2018-09-17 13:47:34 +02:00
LokiNet is the reference implementation of LLARP (low latency anonymous routing protocol), a layer 3 onion routing protocol.
2017-10-03 21:14:46 +02:00
2018-10-08 14:21:29 +02:00
You can learn more about the high level design of LLARP [here ](docs/high-level.txt )
2018-07-30 06:38:14 +02:00
2018-10-08 14:21:29 +02:00
And you can read the LLARP protocol specification [here ](docs/proto_v0.txt )
2018-06-01 20:23:01 +02:00
2018-10-23 13:51:11 +02:00
![build status ](https://gitlab.com/lokiproject/loki-network/badges/master/pipeline.svg "build status" )
2018-08-13 10:47:24 +02:00
2018-10-23 13:51:11 +02:00
## Building
2018-08-13 10:47:24 +02:00
Build requirements:
2018-10-23 13:29:37 +02:00
* GNU Make
2018-08-13 10:47:24 +02:00
* CMake
2018-10-23 13:29:37 +02:00
* C++ 17 capable C++ compiler
2018-10-27 14:41:04 +02:00
* rapidjson (if enabling jsonrpc server)
2019-01-13 02:41:25 +01:00
* gcovr (if generating test coverage with gcc)
2018-08-13 10:47:24 +02:00
2018-10-28 15:28:13 +01:00
### Linux
build:
2018-10-23 13:54:04 +02:00
2018-10-25 19:19:53 +02:00
$ sudo apt install build-essential cmake git libcap-dev wget rapidjson-dev
2018-10-23 13:51:11 +02:00
$ git clone https://github.com/loki-project/loki-network
$ cd loki-network
2018-10-28 15:28:13 +01:00
$ make -j8
install:
2019-01-13 02:41:25 +01:00
2018-10-24 13:57:21 +02:00
$ sudo make install
2018-09-19 14:07:13 +02:00
2018-10-28 15:28:13 +01:00
### FreeBSD
2019-01-13 02:41:25 +01:00
build:
2018-10-28 15:28:13 +01:00
$ pkg install wget cmake git
$ git clone https://github.com/loki-project/loki-network
$ cd loki-network
$ gmake -j8
2019-01-13 02:41:25 +01:00
2018-10-28 15:28:13 +01:00
install (root):
2019-01-13 02:41:25 +01:00
# gmake install
2018-11-12 05:38:17 +01:00
## Windows
2018-11-13 12:03:36 +01:00
build (where `$ARCH` is your platform - `i686` or `x86_64` ):
2018-11-12 05:38:17 +01:00
2018-11-13 12:03:36 +01:00
$ pacman -Sy base-devel mingw-w64-$ARCH-toolchain git libtool autoconf mingw-w64-$ARCH-cmake
2018-11-12 05:38:17 +01:00
$ 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` :
2019-01-13 02:41:25 +01:00
2018-11-12 05:38:17 +01:00
$ make install
2019-01-13 02:41:25 +01:00
if cross-compiling, install mingw-w64 from your distro's package manager, or [build from source ](https://sourceforge.net/p/mingw-w64/wiki2/Cross%20Win32%20and%20Win64%20compiler/ ), then:
2018-11-12 05:38:17 +01:00
$ 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
2018-11-20 00:35:15 +01:00
this will create a static binary that can be installed anywhere, with no other dependency other than libc (minimum v6.1)
2018-10-28 15:28:13 +01:00
2018-11-12 05:38:17 +01:00
## Running on Linux/UNIX/BSD
2018-10-23 13:29:37 +02:00
2018-10-24 13:59:20 +02:00
**DO NOT RUN AS ROOT**, run as normal user.
2018-10-24 13:57:21 +02:00
2018-10-27 14:41:04 +02:00
to run as client:
2018-10-24 13:57:21 +02:00
$ lokinet -g
$ lokinet-bootstrap
$ lokinet
2018-09-09 14:27:56 +02:00
2018-10-27 14:41:04 +02:00
to run as relay:
2018-10-28 15:12:00 +01:00
$ lokinet -r -g
$ lokinet-bootstrap
$ lokinet
2018-10-27 14:41:04 +02:00
2018-11-12 05:38:17 +01:00
## Running on Windows
**DO NOT RUN AS ELEVATED USER**, run as normal user.
2018-12-21 14:14:57 +01:00
to run as client, run the `run-lokinet.bat` batch file as your normal user.
2018-11-12 05:38:17 +01:00
2018-09-17 13:47:34 +02:00
## Usage
2018-09-09 14:27:56 +02:00
2018-10-23 13:51:11 +02:00
see the [documentation ](https://loki-project.github.io/loki-docs/Lokinet/LokinetOverview/ ) on how to get started.