lokinet/readme.md

# 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 design of LLARP [here](docs/high-level.txt)

And you can read the LLARP protocol specification [here](docs/proto_v0.txt)

![build status](https://gitlab.com/lokiproject/loki-network/badges/master/pipeline.svg "build status")

## Building

Build requirements:

* GNU Make
* CMake
* C++ 17 capable C++ compiler
* rapidjson (if enabling jsonrpc server)

To build:

    $ sudo apt install build-essential cmake git libcap-dev wget rapidjson-dev
    $ git clone https://github.com/loki-project/loki-network
    $ cd loki-network
    $ make -j8 JSONRPC=ON
    $ sudo make install

## Running

**DO NOT RUN AS ROOT**, run as normal user.

to run as client:

    $ lokinet -g
    $ lokinet-bootstrap
    $ lokinet

to run as relay:

    $ lokinet -r -g
    $ lokinet-bootstrap
    $ lokinet

## Usage

see the [documentation](https://loki-project.github.io/loki-docs/Lokinet/LokinetOverview/) on how to get started.
Lokinet soft Reveal Moving LLARP under the Loki banner 6 years ago			`# LokiNet`
RFC Signed-off-by: Jon Titor <j.titor@s.g> 7 years ago
update readme add sighup 6 years ago			`LokiNet is the reference implementation of LLARP (low latency anonymous routing protocol), a layer 3 onion routing protocol.`
more 7 years ago
update links in readme 6 years ago			`You can learn more about the high level design of LLARP [here](docs/high-level.txt)`
initial windows server port. Requires Windows 2000 Server or later. - updated CMake build script - builds with Microsoft C++ 19.1x. such builds require Windows 8.1 or later unless you have the .NET Server 2003-toolset (v141_xp) - windows port requires a C++17 compiler since cpp17::filesystem is POSIX-only - HAVE_CXX17_FILESYSTEM manual toggle in CMake. You must manually specify where std::[experimental::]filesystem is defined in LDFLAGS or CMAKE_x_LINKER_FLAGS. - IPv6 support can be added at any time, and the windows sdk still has that inline getaddrinfo(3) if it can't find a suitable IPv6 stack. - inline code for mingw-w64: there's a few bits and pieces still missing simply because mingw-w64 derives its windows sdk from wine and reactos, and then writing all the newer stuff into it by hand straight from the MSDN manpages. - misc. C++11 stuff (nullptr and friends) - Internal file handling code takes UTF-8 or plain 8-bit text, NTFS is UTF-16, so std::filesystem::path::c_str() is wchar_t. That's no good unless you first call std::filesystem::path::string(). - implemented getifaddrs(3) and if_nametoindex(3) on top of GetAdapters[Info\|Addresses](2). - updated readme with new info BONUS: may implement Solaris/illumos IOCP someday... -despair86 6 years ago
update links in readme 6 years ago			`And you can read the LLARP protocol specification [here](docs/proto_v0.txt)`
update readme 6 years ago
update readme and include bootstrap script 6 years ago			`![build status](https://gitlab.com/lokiproject/loki-network/badges/master/pipeline.svg "build status")`
merge 6 years ago
update readme and include bootstrap script 6 years ago			`## Building`
merge 6 years ago
			`Build requirements:`

bundle relevent libsodium parts 6 years ago			`* GNU Make`
merge 6 years ago			`* CMake`
bundle relevent libsodium parts 6 years ago			`* C++ 17 capable C++ compiler`
make jsonrpc server configurable on build, disabled by default. default to client only and require explicitly run as relay to run as relay. 6 years ago			`* rapidjson (if enabling jsonrpc server)`
merge 6 years ago
fix markdown 6 years ago			`To build:`

fix up jsonrpc stuff 6 years ago			`$ sudo apt install build-essential cmake git libcap-dev wget rapidjson-dev`
update readme and include bootstrap script 6 years ago			`$ git clone https://github.com/loki-project/loki-network`
			`$ cd loki-network`
make jsonrpc server configurable on build, disabled by default. default to client only and require explicitly run as relay to run as relay. 6 years ago			`$ make -j8 JSONRPC=ON`
update install target and readme 6 years ago			`$ sudo make install`
update readme 6 years ago
update readme and include bootstrap script 6 years ago			`## Running`
bundle relevent libsodium parts 6 years ago
emphasis 6 years ago			`DO NOT RUN AS ROOT, run as normal user.`
update install target and readme 6 years ago
make jsonrpc server configurable on build, disabled by default. default to client only and require explicitly run as relay to run as relay. 6 years ago			`to run as client:`

update install target and readme 6 years ago			`$ lokinet -g`
			`$ lokinet-bootstrap`
			`$ lokinet`
update readme and make dht bootstrap work with low peer count 6 years ago
make jsonrpc server configurable on build, disabled by default. default to client only and require explicitly run as relay to run as relay. 6 years ago			`to run as relay:`

fix readme indentation 6 years ago			`$ lokinet -r -g`
			`$ lokinet-bootstrap`
			`$ lokinet`
make jsonrpc server configurable on build, disabled by default. default to client only and require explicitly run as relay to run as relay. 6 years ago
update readme add sighup 6 years ago			`## Usage`
update readme and make dht bootstrap work with low peer count 6 years ago
update readme and include bootstrap script 6 years ago			`see the [documentation](https://loki-project.github.io/loki-docs/Lokinet/LokinetOverview/) on how to get started.`