lokinet/readme.md

195 lines
5.6 KiB
Markdown
Raw Normal View History

2019-06-19 19:39:55 +00:00
# Lokinet
[Español](readme_es.md)
2019-06-19 19:38:10 +00:00
Lokinet is the reference implementation of LLARP (low latency anonymous routing protocol), a layer 3 onion routing protocol.
2017-10-03 19:14:46 +00:00
2018-10-08 12:21:29 +00:00
You can learn more about the high level design of LLARP [here](docs/high-level.txt)
2018-10-08 12:21:29 +00:00
And you can read the LLARP protocol specification [here](docs/proto_v0.txt)
2018-06-01 18:23:01 +00:00
You can view documentation on how to get started [here](https://loki-project.github.io/loki-docs/Lokinet/LokinetOverview/) .
![build status](https://gitlab.com/lokiproject/loki-network/badges/master/pipeline.svg "build status")
2019-05-29 07:40:11 +00:00
![travis-ci](https://travis-ci.org/loki-project/loki-network.svg?branch=master "ci status")
2018-08-13 08:47:24 +00:00
## Usage
2019-06-19 19:41:31 +00:00
See the [documentation](https://loki-project.github.io/loki-docs/Lokinet/LokinetOverview/) on how to get started.
Also read the [Public Testing Guide](https://lokidocs.com/Lokinet/Guides/PublicTestingGuide/#1-lokinet-installation) for installation and other helpful information.
2019-04-24 08:07:32 +00:00
## Running on Linux
**DO NOT RUN AS ROOT**, run as normal user. This requires the binary to have the proper setcaps set by `make install` on the binary.
to run as client:
$ lokinet -g
$ lokinet-bootstrap
$ lokinet
to run as relay:
2019-06-19 19:43:03 +00:00
$ lokinet -r -g
$ lokinet-bootstrap
$ lokinet
2019-04-24 08:07:32 +00:00
## Running on MacOS/UNIX/BSD
**YOU HAVE TO RUN AS ROOT**, run using sudo. Elevated privileges are needed to create the virtual tunnel interface.
2019-04-24 08:17:28 +00:00
The MacOS installer places the normal binaries (`lokinet` and `lokinet-bootstrap`) in `/usr/local/bin` which should be in your path, so you can easily use the binaries from your terminal. The installer also nukes your previous config and keys and sets up a fresh config and downloads the latest bootstrap seed.
to run as client:
$ lokinet -g
$ lokinet-bootstrap
$ sudo lokinet
to run as relay:
2019-06-19 19:45:45 +00:00
$ lokinet -r -g
$ lokinet-bootstrap
$ sudo lokinet
## Running on Windows
**DO NOT RUN AS ELEVATED USER**, run as normal user.
to run as client, run the `run-lokinet.bat` batch file as your normal user.
## Building
2018-08-13 08:47:24 +00:00
Build requirements:
2018-10-23 11:29:37 +00:00
* GNU Make
2018-08-13 08:47:24 +00:00
* CMake
2019-12-18 23:43:32 +00:00
* C++ 14 capable C++ compiler
2019-01-13 01:41:25 +00:00
* gcovr (if generating test coverage with gcc)
2019-06-19 19:31:35 +00:00
* libuv >= 1.27.0
* libsodium >= 1.0.18
* libcurl
2018-08-13 08:47:24 +00:00
2018-10-28 14:28:13 +00:00
### Linux
build:
2018-10-23 11:54:04 +00:00
2019-12-31 15:28:19 +00:00
$ sudo apt install build-essential cmake git libcap-dev curl libuv1-dev libsodium-dev libcurl4-openssl-dev pkg-config
$ git clone https://github.com/loki-project/loki-network
$ cd loki-network
2019-06-19 20:34:33 +00:00
$ make
2018-10-28 14:28:13 +00:00
install:
2019-01-13 01:41:25 +00:00
2018-10-24 11:57:21 +00:00
$ sudo make install
2018-09-19 12:07:13 +00:00
2019-05-22 11:56:34 +00:00
alternatively make a debian package with:
$ debuild -uc -us -b
2019-07-02 15:29:28 +00:00
this puts the built packages in `../`
2019-05-22 11:56:34 +00:00
2019-12-26 13:01:29 +00:00
#### Static Linux
static native optimized:
2019-12-26 18:06:02 +00:00
$ make static STATIC_LINK=ON
2019-12-26 13:01:29 +00:00
cross compile fully static armhf (rpi 2 and up)
2019-12-26 13:43:34 +00:00
$ make static STATIC_LINK=ON DOWNLOAD_SODIUM=ON TOOLCHAIN=contrib/cross/armhf.toolchain.cmake
2019-12-26 13:01:29 +00:00
### MacOS
build:
2019-10-27 10:13:22 +00:00
make sure you have cmake, libuv and xcode command line tools installed
$ git clone https://github.com/loki-project/loki-network
$ cd loki-network
$ make -j8
install:
$ sudo make install
### Windows
build (where `$ARCH` is your platform - `i686` or `x86_64`):
$ pacman -Sy base-devel mingw-w64-$ARCH-toolchain git libtool autoconf mingw-w64-$ARCH-cmake
$ git clone https://github.com/loki-project/loki-network.git
$ cd loki-network
$ mkdir -p build; cd build
$ cmake .. -DCMAKE_BUILD_TYPE=[Debug|Release] -DSTATIC_LINK_RUNTIME=ON -DCMAKE_C_COMPILER=gcc -DCMAKE_CXX_COMPILER=g++ -G 'Unix Makefiles'
install (elevated) to `$PROGRAMFILES/lokinet` or `$ProgramFiles(x86)/lokinet`:
$ make install
if cross-compiling, install mingw-w64 from your distro's package manager, or [build from source](https://sourceforge.net/p/mingw-w64/wiki2/Cross%20Win32%20and%20Win64%20compiler/), then:
$ mkdir -p build; cd build
$ export COMPILER=clang # if using clang for windows
$ cmake .. -DCMAKE_BUILD_TYPE=[Debug|Release] -DSTATIC_LINK_RUNTIME=ON -DCMAKE_CROSSCOMPILING=ON -DCMAKE_TOOLCHAIN_FILE=../contrib/cross/mingw[32].cmake
this will create a static binary that can be installed anywhere, with no other dependency other than libc (minimum v6.1)
2019-03-24 08:02:06 +00:00
### Solaris 2.10+
NOTE: Oracle Solaris users need to download/compile the TAP driver from http://www.whiteboard.ne.jp/~admin2/tuntap/
The generated binaries _may_ work on Solaris 2.10 or earlier, you're on your own. (Recommended: `-static-libstdc++ -static-libgcc`, and the TAP driver if not already installed on the target system.)
Building on a v2.10 or earlier system is unsupported, and may not even work; recent GCC releases have progressively dropped support for older system releases.
build:
$ sudo pkg install build-essential gcc8 wget tuntap cmake (optional: ninja ccache - from omnios extra) (OmniOS CE)
$ sudo pkg install base-developer-utilities developer-gnu developer-studio-utilities gcc-7 wget cmake (Oracle Solaris, see note)
$ sudo pkg install build-essential wget gcc-8 documentation/tuntap header-tun tun (optional: ninja ccache) (all other SunOS)
$ git clone https://github.com/loki-project/loki-network
$ cd loki-network
$ gmake -j8
install:
$ sudo make install
### NetBSD (and other platforms where pkgsrc is _the_ native package mgr)
TODO: add pkgsrc instructions
### OpenBSD (uses legacy netbsd pkg manager)
build:
2019-06-13 12:00:45 +00:00
# pkg_add curl cmake git (optional: ninja ccache)
2019-03-24 08:02:06 +00:00
$ git clone https://github.com/loki-project/loki-network
$ cd loki-network
$ gmake -j8
install (root):
# gmake install
2018-10-28 14:28:13 +00:00
### FreeBSD
2019-01-13 01:41:25 +00:00
build:
2018-10-28 14:28:13 +00:00
$ pkg install cmake git curl libuv libsodium pkgconf
2018-10-28 14:28:13 +00:00
$ git clone https://github.com/loki-project/loki-network
$ cd loki-network
2019-12-16 13:59:38 +00:00
$ mkdir build
$ cmake -DCMAKE_BUILD_TYPE=Release ..
$ make
2019-01-13 01:41:25 +00:00
2018-10-28 14:28:13 +00:00
install (root):
2019-01-13 01:41:25 +00:00
2019-12-16 13:59:38 +00:00
# make install