Lokinet is an anonymous, decentralized and IP based overlay network for the internet.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Jeff Becker bf2488d9e8
zero copy compare
3 weeks ago
.github Update issue templates 4 years ago
cmake Set up sign target dependencies always; mark unsigned package 1 month ago
contrib Merge pull request #1971 from majestrate/docs-and-such-2022-08-06 4 weeks ago
crypto Replace logging with oxen-logger 3 months ago
daemon Merge pull request #1971 from majestrate/docs-and-such-2022-08-06 4 weeks ago
docs set up links to new docs pages 1 month ago
external Don't look for sqlite when not building peerstats 1 month ago
gui@df20623961 Update gui submodule to dev branch 1 month ago
include fix up log statements 1 month ago
jni add directory specific readmes 2 months ago
llarp zero copy compare 3 weeks ago
pybind add directory specific readmes 2 months ago
test Don't build peerstats tests when peer stats disabled 1 month ago
win32-setup move windows nsis parts for cpack into external files 4 months ago
.clang-format Config file improvements (#1397) 2 years ago
.clang-tidy Tweak clang-tidy rules 2 years ago
.dir-locals.el add emacs dir-locals 4 years ago
.dockerignore Add fail-able docker build for gcc trunk 3 years ago
.drone.jsonnet Drone macos fixes 1 month ago
.gitattributes Add mainnet/testnet bootstrap files into repo 1 year ago
.gitignore Add mainnet/testnet bootstrap files into repo 1 year ago
.gitmodules Build apple/macos GUI from lokinet project 2 months ago
.swift-version add swift version bullshit file and additional bullshittery 1 year ago
CMakeLists.txt Don't look for sqlite when not building peerstats 1 month ago
CMakeSettings.json Fixup MSVC build 3 years ago
CONTRIBUTING.md Update CONTRIBUTING.md 3 years ago
CONTRIBUTING_es.md Create CONTRIBUTING_es.md 3 years ago
LICENSE make it so github sees the repo is gpl3 8 months ago
readme.md wire up new docs pages 1 month ago
readme_es.md Add missing dep 'cppzmq' (#1764) 12 months ago
readme_fr.md add french readme 4 months ago
readme_ru.md Add missing dep 'cppzmq' (#1764) 12 months ago

readme.md

Lokinet

Español Русский Français

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, how to use it and the internals of the protocol here

Build Status

Installing

If you are simply looking to install Lokinet and don't want to compile it yourself we provide several options for platforms to run on:

Tier 1:

Tier 2:

Currently Unsupported Platforms: (maintainers welcome)

  • Apple iPhone
  • Homebrew
  • [Insert Flavor of the Month windows package manager here]

Building

Build requirements:

  • Git
  • CMake
  • C++ 17 capable C++ compiler
  • libuv >= 1.27.0
  • libsodium >= 1.0.18
  • libssl (for lokinet-bootstrap)
  • libcurl (for lokinet-bootstrap)
  • libunbound
  • libzmq
  • cppzmq
  • sqlite3

Linux

You do not have to build from source if you are on debian or ubuntu as we have apt repositories with pre-built lokinet packages on deb.oxen.io or rpm.oxen.io.

You can install debian packages using:

$ sudo curl -so /etc/apt/trusted.gpg.d/oxen.gpg https://deb.oxen.io/pub.gpg
$ echo "deb https://deb.oxen.io $(lsb_release -sc) main" | sudo tee /etc/apt/sources.list.d/oxen.list
$ sudo apt update
$ sudo apt install lokinet

If you want to build from source:

$ sudo apt install build-essential cmake git libcap-dev pkg-config automake libtool libuv1-dev libsodium-dev libzmq3-dev libcurl4-openssl-dev libevent-dev nettle-dev libunbound-dev libsqlite3-dev libssl-dev nlohmann-json3-dev
$ git clone --recursive https://github.com/oxen-io/lokinet
$ cd lokinet
$ mkdir build
$ cd build
$ cmake .. -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=OFF
$ make -j$(nproc)
$ sudo make install

Arch Linux

Due to circumstances beyond our control a working PKGBUILD can be found here.

Cross Compile For Linux

current cross targets:

  • aarch64-linux-gnu
  • arm-linux-gnueabihf
  • mips-linux-gnu
  • mips64-linux-gnuabi64
  • mipsel-linux-gnu
  • powerpc64le-linux-gnu

install the toolchain (this one is for aarch64-linux-gnu, you can provide your own toolchain if you want)

$ sudo apt install g{cc,++}-aarch64-linux-gnu

build 1 or many cross targets:

$ ./contrib/cross.sh arch_1 arch_2 ... arch_n

MacOS

Source code compilation of Lokinet by end users is not supported or permitted by apple on their platforms, see this for more information.

If you find this disagreeable consider using a platform that permits compiling from source.

Windows

You can get the latest stable windows release from https://lokinet.org/ or check the releases page on github.

nightly builds for the brave or impatient can be found from our CI pipeline here

Building For Windows

windows builds are cross compiled from debian/ubuntu linux

additional build requirements:

  • nsis
  • cpack

setup:

$ sudo apt install build-essential cmake git pkg-config mingw-w64 nsis cpack automake libtool
$ sudo update-alternatives --set x86_64-w64-mingw32-gcc /usr/bin/x86_64-w64-mingw32-gcc-posix
$ sudo update-alternatives --set x86_64-w64-mingw32-g++ /usr/bin/x86_64-w64-mingw32-g++-posix

building:

$ git clone --recursive https://github.com/oxen-io/lokinet
$ cd lokinet
$ ./contrib/windows.sh

FreeBSD

Currently has no VPN Platform code, see #1513

build:

$ pkg install cmake git pkgconf
$ git clone --recursive https://github.com/oxen-io/lokinet
$ cd lokinet
$ mkdir build
$ cd build
$ cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=OFF -DSTATIC_LINK=ON -DBUILD_STATIC_DEPS=ON ..
$ make

install (root):

# make install

Android

We have an Android APK for lokinet VPN via android VPN API.

Coming to F-Droid whenever that happens. [issue]

Usage

Debian / Ubuntu packages

When running from debian package the following steps are not needed as it is already running and ready to use. You can stop/start/restart it using systemctl start lokinet, systemctl stop lokinet, etc.

Running on Linux (without debs)

DO NOT RUN AS ROOT, run as normal user.

set up the initial configs:

$ lokinet -g
$ lokinet-bootstrap

after you create default config, run it:

$ lokinet

This requires the binary to have the proper capabilities which is usually set by make install on the binary. If you have errors regarding permissions to open a new interface this can be resolved using:

$ sudo setcap cap_net_admin,cap_net_bind_service=+eip /usr/local/bin/lokinet

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Copyright © 2018-2022 The Oxen Project
Copyright © 2018-2022 Jeff Becker
Copyright © 2018-2020 Rick V. (Historical Windows NT port and portions)