2018-06-16 12:31:48 +00:00
|
|
|
# LokiNet
|
2017-09-22 21:06:48 +00:00
|
|
|
|
2018-09-17 11:47:34 +00:00
|
|
|
LokiNet is the reference implementation of LLARP (low latency anonymous routing protocol), a layer 3 onion routing protocol.
|
2017-10-03 19:14:46 +00:00
|
|
|
|
2018-06-16 12:31:48 +00:00
|
|
|
You can learn more about the high level design of LLARP [here](doc/high-level.txt)
|
2018-07-30 04:38:14 +00:00
|
|
|
|
2018-06-16 12:31:48 +00:00
|
|
|
And you can read the LLARP protocol specification [here](doc/proto_v0.txt)
|
2018-06-01 18:23:01 +00:00
|
|
|
|
2018-08-13 08:47:24 +00:00
|
|
|
## Building
|
|
|
|
|
|
|
|
$ sudo apt install build-essential libtool autoconf cmake git
|
|
|
|
$ git clone --recursive https://github.com/loki-project/lokinet-builder
|
|
|
|
$ cd lokinet-builder
|
|
|
|
$ make
|
|
|
|
|
|
|
|
## Running
|
|
|
|
|
|
|
|
$ ./lokinet
|
|
|
|
|
|
|
|
### Development
|
|
|
|
|
|
|
|
Please note development builds are likely to be unstable
|
|
|
|
|
|
|
|
Build requirements:
|
|
|
|
|
|
|
|
* CMake
|
|
|
|
* ninja
|
|
|
|
* libsodium >= 1.0.14
|
|
|
|
* c++ 11 capable C++ compiler (gcc 7.x+, llvm 3.8+)
|
|
|
|
|
|
|
|
|
|
|
|
Building a debug build:
|
2018-09-24 21:05:41 +00:00
|
|
|
|
2018-06-01 18:23:01 +00:00
|
|
|
|
2018-09-19 12:07:13 +00:00
|
|
|
|
2018-09-17 11:47:34 +00:00
|
|
|
## Building
|
2018-09-09 12:27:56 +00:00
|
|
|
|
2018-09-19 12:07:13 +00:00
|
|
|
![build status](https://gitlab.com/lokiproject/loki-network/badges/master/pipeline.svg "build status")
|
|
|
|
|
|
|
|
|
2018-09-25 18:29:55 +00:00
|
|
|
use the [lokinet builder](https://github.com/loki-project/lokinet-builder) repo.
|
2018-09-19 12:07:13 +00:00
|
|
|
|
2018-09-25 18:29:55 +00:00
|
|
|
for a development environment:
|
2018-09-09 12:27:56 +00:00
|
|
|
|
2018-09-19 12:07:13 +00:00
|
|
|
$ sudo apt install git libcap-dev build-essential ninja-build cmake libsodium-dev
|
|
|
|
$ git clone https://github.com/loki-project/loki-network
|
|
|
|
$ cd loki-network
|
|
|
|
$ make
|
2018-09-09 12:27:56 +00:00
|
|
|
|
2018-09-17 11:47:34 +00:00
|
|
|
## Usage
|
2018-09-09 12:27:56 +00:00
|
|
|
|
2018-09-17 11:47:34 +00:00
|
|
|
### Windows
|
|
|
|
|
|
|
|
Windows only supports client mode so you run `lokinet.exe` and that's it.
|
|
|
|
|
|
|
|
### Linux
|
|
|
|
|
2018-09-25 13:09:38 +00:00
|
|
|
see the [lokinet-builder](https://github.com/loki-project/lokinet-builder)
|