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