mirror of
https://github.com/oxen-io/lokinet.git
synced 2024-10-31 09:20:21 +00:00
179 lines
5.2 KiB
Markdown
179 lines
5.2 KiB
Markdown
# Lokinet
|
|
|
|
[Español](readme_es.md) [Русский](readme_ru.md)
|
|
|
|
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](docs/)
|
|
|
|
[](https://ci.oxen.rocks/oxen-io/lokinet)
|
|
|
|
## 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:
|
|
|
|
* [Linux](#linux-install)
|
|
* [Android](#apk-install)
|
|
|
|
Tier 2:
|
|
|
|
* [Windows](#windows-install)
|
|
* [MacOS](#mac-install)
|
|
* [FreeBSD](#freebsd-install)
|
|
|
|
Currently Unsupproted 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 <span id="linux-install" />
|
|
|
|
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
|
|
|
|
#### Cross Compile For Linux <span id="linux-cross" />
|
|
|
|
install the toolchain for `$arch` this example is `aarch64`
|
|
|
|
$ sudo apt install g{cc,++}-aarch64-linux-gnu
|
|
|
|
build 1 or many cross targets:
|
|
|
|
$ ./contrib/cross.sh arch_1 arch_2 ... arch_n
|
|
|
|
### MacOS <span id="mac-install" />
|
|
|
|
Lokinet ~~is~~ will be available on the Apple App store.
|
|
|
|
Source code compilation of Lokinet by end users is not supported or permitted by apple on their platforms, see [this](contrib/macos/README.txt) for more information. If you find this disagreeable consider using a platform that permits compiling from source.
|
|
|
|
### Windows <span id="windows-install" />
|
|
|
|
You can get the latest stable windows release from https://lokinet.org/ or check the [releases page on github](https://github.com/oxen-io/lokinet/releases).
|
|
|
|
nightly builds for the brave or impatient can be found from our CI pipeline [here](https://oxen.rocks/oxen-io/lokinet/)
|
|
|
|
#### Building For Windows <span id="win32-cross" />
|
|
|
|
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
|
|
|
|
building:
|
|
|
|
$ git clone --recursive https://github.com/oxen-io/lokinet
|
|
$ cd lokinet
|
|
$ ./contrib/windows.sh
|
|
|
|
### FreeBSD <span id="freebsd-install" />
|
|
|
|
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 <span id="apk-install" />
|
|
|
|
We have an Android APK for lokinet VPN via android VPN API.
|
|
|
|
Coming to F-Droid whenever that happens. [[issue]](https://github.com/oxen-io/lokinet-flutter-app/issues/8)
|
|
|
|
* [source code](https://github.com/oxen-io/lokinet-flutter-app)
|
|
* [CI builds](https://oxen.rocks/oxen-io/lokinet/)
|
|
|
|
## Usage
|
|
|
|
### Debian / Ubuntu packages <span id="systemd-linux-usage" />
|
|
|
|
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) <span id="arcane-linux-usage" />
|
|
|
|
**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)
|
|
```
|