If you are simply looking to install Lokinet and don't want to compile it yourself we provide several options:
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)
* [Linux](#linux-install)
* [Android](#apk-install)
Tier 2:
* [Windows](#windows-install)
* [Windows](#windows-install)
* [macOS](#mac-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
## Building
@ -40,9 +47,9 @@ Build requirements:
### Linux <spanid="linux-install"/>
### Linux <spanid="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`.
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`.
@ -61,16 +68,7 @@ If you want to build from source:
$ make -j$(nproc)
$ make -j$(nproc)
$ sudo make install
$ sudo make install
#### Cross Compile
#### Cross Compile For Linux <spanid="linux-cross"/>
supported cross targets:
* aarch64
* armhf
* mips
* mips64
* mipsel
* ppc64le
install the toolchain for `$arch` this example is `aarch64`
install the toolchain for `$arch` this example is `aarch64`
@ -80,7 +78,7 @@ build 1 or many cross targets:
$ ./contrib/cross.sh arch_1 arch_2 ... arch_n
$ ./contrib/cross.sh arch_1 arch_2 ... arch_n
### macOS <spanid="mac-install"/>
### MacOS <spanid="mac-install"/>
Lokinet ~~is~~ will be available on the Apple App store.
Lokinet ~~is~~ will be available on the Apple App store.
@ -88,7 +86,11 @@ Source code compilation of Lokinet by end users is not supported or permitted by
### Windows <spanid="windows-install"/>
### Windows <spanid="windows-install"/>
You can get the latest stable windows release from https://lokinet.org/ or check the releases page on github.
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 <spanid="win32-cross"/>
windows builds are cross compiled from debian/ubuntu linux
windows builds are cross compiled from debian/ubuntu linux
@ -107,7 +109,9 @@ building:
$ cd lokinet
$ cd lokinet
$ ./contrib/windows.sh
$ ./contrib/windows.sh
### FreeBSD
### FreeBSD <spanid="freebsd-install"/>
Currently has no VPN Platform code, see #1513
build:
build:
@ -123,15 +127,24 @@ install (root):
# make install
# make install
### Android <spanid="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)