mirror of
https://github.com/oxen-io/lokinet
synced 2023-12-14 06:53:00 +01:00
Merge pull request #1986 from majestrate/docs-2022-09-04
restructure readme and docs
This commit is contained in:
commit
f777075893
3 changed files with 181 additions and 175 deletions
173
docs/install.md
Normal file
173
docs/install.md
Normal file
|
@ -0,0 +1,173 @@
|
||||||
|
# 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)
|
||||||
|
* [Windows](#windows-install)
|
||||||
|
* [MacOS](#macos-install)
|
||||||
|
|
||||||
|
Tier 2:
|
||||||
|
|
||||||
|
* [FreeBSD](#freebsd-install)
|
||||||
|
|
||||||
|
Currently Unsupported Platforms: (maintainers welcome)
|
||||||
|
|
||||||
|
* Apple iPhone
|
||||||
|
* Homebrew
|
||||||
|
* \[Insert Flavor of the Month windows package manager here\]
|
||||||
|
|
||||||
|
|
||||||
|
## Official Builds
|
||||||
|
|
||||||
|
### Windows / MacOS <span id="windows-install" /> <span id="macos-install" />
|
||||||
|
|
||||||
|
You can get the latest stable release for lokinet on windows or macos from https://lokinet.org/ or check the [releases page on github](https://github.com/oxen-io/lokinet/releases).
|
||||||
|
|
||||||
|
### Linux <span id="linux-install" />
|
||||||
|
|
||||||
|
You do not have to build from source if you do not wish to, we provide [apt](#deb-install) and [rpm](#rpm-install) repos.
|
||||||
|
|
||||||
|
#### APT repository <span id="deb-install" />
|
||||||
|
|
||||||
|
You can install debian packages from `deb.oxen.io` by adding the apt repo to your system.
|
||||||
|
|
||||||
|
$ 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
|
||||||
|
|
||||||
|
This apt repo is also available via lokinet at `http://deb.loki`
|
||||||
|
|
||||||
|
Once added you can install lokinet with:
|
||||||
|
|
||||||
|
$ sudo apt update
|
||||||
|
$ sudo apt install lokinet
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
#### RPM <span id="rpm-install" />
|
||||||
|
|
||||||
|
We also provide an RPM repo, see `rpm.oxen.io`, also available on lokinet at `rpm.loki`
|
||||||
|
|
||||||
|
## Bleeding Edge dev builds <span id="ci-builds" />
|
||||||
|
|
||||||
|
automated builds from dev branches for the brave or impatient can be found from our CI pipeline [here](https://oxen.rocks/oxen-io/lokinet/). (warning: these nightly builds may or may not consume your first born child.)
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
### Linux Compile
|
||||||
|
|
||||||
|
If you want to build from source: <span id="linux-compile" />
|
||||||
|
|
||||||
|
$ 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 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
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
|
||||||
|
#### Arch Linux <span id="mom-cancel-my-meetings-arch-linux-broke-again" />
|
||||||
|
|
||||||
|
Due to [circumstances beyond our control](https://github.com/oxen-io/lokinet/discussions/1823) a working `PKGBUILD` can be found [here](https://raw.githubusercontent.com/oxen-io/lokinet/makepkg/contrib/archlinux/PKGBUILD).
|
||||||
|
|
||||||
|
#### Cross Compile For Linux <span id="linux-cross" />
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
### 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
|
||||||
|
$ 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
|
||||||
|
|
||||||
|
### Compiling for MacOS <span id="mac-compile" />
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### FreeBSD <span id="freebsd-install" />
|
||||||
|
|
||||||
|
Currently has no VPN Platform code, see issue `#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)
|
|
@ -2,14 +2,16 @@
|
||||||
|
|
||||||
This is where Lokinet documentation lives.
|
This is where Lokinet documentation lives.
|
||||||
|
|
||||||
|
[How Do I install Lokinet?](install.md)
|
||||||
|
|
||||||
|
[How Do I use Lokinet?](ideal-ux.md)
|
||||||
|
|
||||||
## High level
|
## High level
|
||||||
|
|
||||||
[How is Lokinet different to \[insert network technology name here\] ?](net-comparisons.md)
|
[How is Lokinet different to \[insert network technology name here\] ?](net-comparisons.md)
|
||||||
|
|
||||||
<!-- [How does Lokinet work?](high-level-overview.md) -->
|
<!-- [How does Lokinet work?](high-level-overview.md) -->
|
||||||
|
|
||||||
[How Do I use Lokinet?](ideal-ux.md)
|
|
||||||
|
|
||||||
[Lokinet and DNS](dns-overview.md)
|
[Lokinet and DNS](dns-overview.md)
|
||||||
|
|
||||||
[What Lokinet can't do](we-cannot-make-sandwiches.md)
|
[What Lokinet can't do](we-cannot-make-sandwiches.md)
|
||||||
|
|
177
readme.md
177
readme.md
|
@ -1,184 +1,15 @@
|
||||||
# Lokinet
|
# Lokinet
|
||||||
|
|
||||||
[Español](readme_es.md) [Русский](readme_ru.md) [Français](readme_fr.md)
|
<!-- [Español](readme_es.md) [Русский](readme_ru.md) [Français](readme_fr.md) -->
|
||||||
|
|
||||||
Lokinet is the reference implementation of LLARP (low latency anonymous routing protocol), a layer 3 onion routing protocol.
|
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](docs/)
|
### Installation instructions can be found [here](docs/install.md).
|
||||||
|
|
||||||
|
#### You can learn more about the high level, how to use it and the internals of the protocol [here](docs/)
|
||||||
|
|
||||||
[![Build Status](https://ci.oxen.rocks/api/badges/oxen-io/lokinet/status.svg?ref=refs/heads/dev)](https://ci.oxen.rocks/oxen-io/lokinet)
|
[![Build Status](https://ci.oxen.rocks/api/badges/oxen-io/lokinet/status.svg?ref=refs/heads/dev)](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)
|
|
||||||
* [Windows](#windows-install)
|
|
||||||
* [MacOS](#mac-install)
|
|
||||||
|
|
||||||
Tier 2:
|
|
||||||
|
|
||||||
* [FreeBSD](#freebsd-install)
|
|
||||||
|
|
||||||
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 <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
|
|
||||||
|
|
||||||
#### Arch Linux <span id="mom-cancel-my-meetings-arch-linux-broke-again" />
|
|
||||||
|
|
||||||
Due to [circumstances beyond our control](https://github.com/oxen-io/lokinet/discussions/1823) a working `PKGBUILD` can be found [here](https://raw.githubusercontent.com/oxen-io/lokinet/makepkg/contrib/archlinux/PKGBUILD).
|
|
||||||
|
|
||||||
#### Cross Compile For Linux <span id="linux-cross" />
|
|
||||||
|
|
||||||
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 <span id="mac-install" />
|
|
||||||
|
|
||||||
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
|
|
||||||
$ 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 <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
|
# License
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
|
Loading…
Reference in a new issue