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-08-13 10:47:24 +02:00
|
|
|
|
2018-10-23 13:54:04 +02:00
|
|
|
To build:
|
|
|
|
|
2018-10-23 13:51:11 +02:00
|
|
|
$ sudo apt install build-essential cmake git libcap-dev
|
|
|
|
$ git clone https://github.com/loki-project/loki-network
|
|
|
|
$ cd loki-network
|
|
|
|
$ make -j8
|
2018-09-19 14:07:13 +02:00
|
|
|
|
2018-10-23 13:51:11 +02:00
|
|
|
## Running
|
2018-10-23 13:29:37 +02:00
|
|
|
|
2018-10-24 13:47:57 +02:00
|
|
|
$ ./lokinet -g
|
2018-10-23 13:51:11 +02:00
|
|
|
$ ./lokinet-bootstrap
|
|
|
|
$ ./lokinet
|
2018-09-09 14:27:56 +02: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.
|