1
1
Fork 0
mirror of https://github.com/oxen-io/lokinet synced 2023-12-14 06:53:00 +01:00
Lokinet is an anonymous, decentralized and IP based overlay network for the internet.
Find a file
2018-11-15 11:12:05 -05:00
.github add contributing template 2018-09-28 10:34:37 -04:00
.idea make android build work in android studio 2018-11-07 07:23:06 -05:00
.vscode fix debian build 2018-11-13 10:16:14 -05:00
android make android build work in android studio 2018-11-07 07:23:06 -05:00
client Enable -Wextra 2018-11-07 15:31:13 +00:00
contrib make android compile again 2018-11-06 09:06:09 -05:00
crypto fix debian build 2018-11-13 10:16:14 -05:00
daemon wire up exit traffic 2018-11-14 14:34:17 -05:00
debian fix debian build 2018-11-13 10:16:14 -05:00
docker Enable warnings as errors 2018-11-06 22:48:17 +00:00
docs more exit stuff 2018-11-14 13:02:27 -05:00
include explicit type 2018-11-15 11:05:31 -05:00
jni make android compile again 2018-11-06 09:06:09 -05:00
libabyss Merge remote-tracking branch 'rick/dev' 2018-11-07 11:05:47 -05:00
libutp remove dead code 2018-11-13 06:30:40 -06:00
llarp friendship with std::unordered_map is now over, std::map is my new best friend 2018-11-15 11:12:05 -05:00
test initial exit/service node comm code with some unit tests (incomplete) 2018-11-12 11:43:40 -05:00
vendor remove dead code 2018-11-13 06:30:40 -06:00
win32-setup remove dead code 2018-11-13 06:30:40 -06:00
.clang-format more netns code 2018-08-26 08:51:22 -04:00
.dir-locals.el add emacs dir-locals 2018-05-21 10:52:30 -04:00
.dockerignore Add initial dockerfile support 2018-11-02 18:06:01 -04:00
.gitignore make windows cross compile pass, make format parts of libutp 2018-11-09 07:56:04 -05:00
.gitlab-ci.yml disable windows in ci 2018-11-09 08:26:50 -05:00
CMakeLists.txt Merge remote-tracking branch 'rick/dev' into dev 2018-11-13 10:25:07 -05:00
CODE_OF_CONDUCT.md add file to check a github checkbox 2018-09-28 10:31:46 -04:00
doc place protocol spec into public domain with CC0 2018-10-08 08:15:08 -04:00
LICENSE place protocol spec into public domain with CC0 2018-10-08 08:15:08 -04:00
lokinet-bootstrap try fixing debian build 2018-11-13 08:37:35 -05:00
lokinet-bootstrap.exe grabbed packaging scripts and fluff from abandoned repo 2018-10-30 00:16:18 -05:00
Makefile fix debian build 2018-11-13 10:16:14 -05:00
motto.txt update motto for release 2018-11-06 07:02:22 -05:00
readme.md Update readme.md 2018-11-13 05:03:36 -06:00

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

build status

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 (7.0)

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.