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
2019-04-30 12:49:34 -04:00
.github Update issue templates 2019-04-17 13:33:37 +10:00
android make android compile 2019-04-08 11:54:19 -04:00
client Enable -Wextra 2018-11-07 15:31:13 +00:00
cmake Refactor top level cmake file into multiple components 2019-04-30 00:48:48 +01:00
contrib Remove duplicate and unnecessary fields 2019-04-27 23:10:31 +10:00
crypto More work on router docker image 2019-04-28 17:04:52 +01:00
daemon Merge pull request #556 from neuroscr/issue547-2 2019-04-23 17:40:54 -07:00
debian more 2019-04-05 10:58:22 -04:00
docker More work on router docker image 2019-04-28 17:04:52 +01:00
docs bundle RC in build record to improve build success rates. 2019-04-17 15:05:54 -04:00
include Allow builds on MSVC (#518) 2019-04-19 13:24:33 -05:00
jni make android compile 2019-04-08 11:54:19 -04:00
libabyss Refactor top level cmake file into multiple components 2019-04-30 00:48:48 +01:00
libhttp build fixes: using -s on Sun strips the ELF export symbol table, which leads to Bad Things if yer using the GNU linker for some godforsaken reason 2019-04-11 10:13:26 -05:00
libutp Allow builds on MSVC (#518) 2019-04-19 13:24:33 -05:00
llarp queue pending traffic 2019-04-30 12:49:34 -04:00
osx-setup fix syntax error 2019-04-23 16:19:01 -07:00
test handle subdomains 2019-04-26 08:14:29 -04:00
ui-win32 new loki AboutBox logo 2019-04-06 23:04:04 -05:00
vendor remove install from cmake 2019-04-21 17:35:10 -04:00
win32-setup nits 2019-03-20 20:55:58 -05: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 Move IWP code to its own directory 2019-03-29 16:00:12 +00:00
.gitignore Allow builds on MSVC (#518) 2019-04-19 13:24:33 -05:00
.gitlab-ci.yml Remove mention of rapidjson from readme/docker files etc 2019-03-02 02:32:18 +00:00
CMakeLists.txt Refactor top level cmake file into multiple components 2019-04-30 00:48:48 +01:00
CMakeSettings.json Allow builds on MSVC (#518) 2019-04-19 13:24:33 -05:00
CONTRIBUTING.md Rename CODE_OF_CONDUCT.md to CONTRIBUTING.md 2018-12-12 10:38:15 +10:00
doc place protocol spec into public domain with CC0 2018-10-08 08:15:08 -04:00
Doxyfile basic doxygen configuration 2018-12-17 03:24:11 +10:00
LICENSE more branding 2019-03-20 05:38:00 -05:00
lokinet-bootstrap More work on router docker image 2019-04-28 17:04:52 +01:00
lokinet-bootstrap-testnet.exe fix internal testnet bootstrap 2019-03-20 19:46:37 -05:00
lokinet-bootstrap.exe fix installer bootstrap 2019-03-20 19:37:39 -05:00
lokinet-docker.ini got router working in docker 2019-04-24 02:10:21 +00:00
Makefile More work on router docker image 2019-04-28 17:04:52 +01:00
module.modulemap Initial swift module.modulemap file for LLARP 2018-12-15 01:23:06 +10:00
motto.txt update motto for release 2019-03-18 08:28:47 -04:00
readme.md Explain MacOS installer 2019-04-24 01:17:28 -07:00
run-lokinet.bat add run-lokinet.bat super duper simple wrapper thingydoo for windows 2018-12-21 08:11:59 -05:00
testnet_readme.md update testnet docs and add more tuneable paramters 2019-02-07 08:20:03 -05: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

You can view documentation on how to get started here .

build status

Usage

see the documentation on how to get started.

Also read the Public Testing Guide for installation and other helpful information.

Running on Linux

DO NOT RUN AS ROOT, run as normal user. This requires the binary to have the proper setcaps set by make install on the binary.

to run as client:

$ lokinet -g
$ lokinet-bootstrap
$ lokinet

to run as relay:

$ lokinet -r
$ lokinet-bootstrap
$ lokinet

Running on MacOS/UNIX/BSD

YOU HAVE TO RUN AS ROOT, run using sudo. Elevated privileges are needed to create the virtual tunnel interface.

The MacOS installer places the normal binaries (lokinet and lokinet-bootstrap) in /usr/local/bin which should be in your path, so you can easily use the binaries from your terminal. The installer also nukes your previous config and keys and sets up a fresh config and downloads the latest bootstrap seed.

to run as client:

$ lokinet -g
$ lokinet-bootstrap
$ sudo lokinet

to run as relay:

$ lokinet -r
$ lokinet-bootstrap
$ sudo lokinet

Running on Windows

DO NOT RUN AS ELEVATED USER, run as normal user.

to run as client, run the run-lokinet.bat batch file as your normal user.

Building

Build requirements:

  • GNU Make
  • CMake
  • C++ 17 capable C++ compiler
  • gcovr (if generating test coverage with gcc)
  • IMPORTANT NOTE: To use the optimiser, make sure the default -DNDEBUG macro is removed before generating (see #400)

Linux

build:

$ sudo apt install build-essential cmake git libcap-dev wget
$ git clone https://github.com/loki-project/loki-network
$ cd loki-network
$ make -j8

install:

$ sudo make install

MacOS

build: make sure you have cmake and xcode command line tools installed

$ git clone https://github.com/loki-project/loki-network
$ cd loki-network
$ make -j8

install:

$ sudo make 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_RUNTIME=ON -DCMAKE_C_COMPILER=gcc -DCMAKE_CXX_COMPILER=g++ -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_RUNTIME=ON -DCMAKE_CROSSCOMPILING=ON -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)

Solaris 2.10+

NOTE: Oracle Solaris users need to download/compile the TAP driver from http://www.whiteboard.ne.jp/~admin2/tuntap/

The generated binaries may work on Solaris 2.10 or earlier, you're on your own. (Recommended: -static-libstdc++ -static-libgcc, and the TAP driver if not already installed on the target system.)

Building on a v2.10 or earlier system is unsupported, and may not even work; recent GCC releases have progressively dropped support for older system releases.

build:

$ sudo pkg install build-essential gcc8 wget tuntap cmake (optional: ninja ccache - from omnios extra) (OmniOS CE)
$ sudo pkg install base-developer-utilities developer-gnu developer-studio-utilities gcc-7 wget cmake (Oracle Solaris, see note)
$ sudo pkg install build-essential wget gcc-8 documentation/tuntap header-tun tun (optional: ninja ccache) (all other SunOS)
$ git clone https://github.com/loki-project/loki-network
$ cd loki-network
$ gmake -j8

install:

$ sudo make install

NetBSD (and other platforms where pkgsrc is the native package mgr)

TODO: add pkgsrc instructions

OpenBSD (uses legacy netbsd pkg manager)

build:

# pkg_add wget cmake git (optional: ninja ccache)
$ git clone https://github.com/loki-project/loki-network
$ cd loki-network
$ gmake -j8

install (root):

# gmake 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