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](doc/high-level.txt)

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

## Building

To build lokinet see the [lokinet builder](https://github.com/loki-project/lokinet-builder)


## Usage

### Windows

Windows only supports client mode so you run `lokinet.exe` and that's it.

### Linux

Client mode:

For simple testing do:

    $ lokinet
   
On systemd based distros you can persist it in the background:

    # systemctl enable --now lokinet-client
   
   
Relay mode:

you can participate as a relay node trivially (for now).

On systemd based linux distros do:

    # systemctl enable --now lokinet-relay

Alternatively:

    # mkdir /usr/local/lokinet
    # cd /usr/local/lokinet
    # lokinet --genconf daemon.ini
    # lokinet --check daemon.ini 
    # lokinet /usr/local/lokinet/daemon.ini
Lokinet soft Reveal Moving LLARP under the Loki banner 2018-06-16 12:31:48 +00:00			`# LokiNet`
RFC Signed-off-by: Jon Titor <j.titor@s.g> 2017-09-22 21:06:48 +00:00
update readme add sighup 2018-09-17 11:47:34 +00:00			`LokiNet is the reference implementation of LLARP (low latency anonymous routing protocol), a layer 3 onion routing protocol.`
more 2017-10-03 19:14:46 +00:00
Lokinet soft Reveal Moving LLARP under the Loki banner 2018-06-16 12:31:48 +00:00			`You can learn more about the high level design of LLARP [here](doc/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 2018-07-30 04:38:14 +00:00
Lokinet soft Reveal Moving LLARP under the Loki banner 2018-06-16 12:31:48 +00:00			`And you can read the LLARP protocol specification [here](doc/proto_v0.txt)`
update readme 2018-06-01 18:23:01 +00:00
update readme add sighup 2018-09-17 11:47:34 +00:00			`## Building`
update readme and make dht bootstrap work with low peer count 2018-09-09 12:27:56 +00:00
update readme add sighup 2018-09-17 11:47:34 +00:00			`To build lokinet see the [lokinet builder](https://github.com/loki-project/lokinet-builder)`
update readme and make dht bootstrap work with low peer count 2018-09-09 12:27:56 +00:00

update readme add sighup 2018-09-17 11:47:34 +00:00			`## Usage`
update readme and make dht bootstrap work with low peer count 2018-09-09 12:27:56 +00:00
update readme add sighup 2018-09-17 11:47:34 +00:00			`### Windows`

			Windows only supports client mode so you run `lokinet.exe` and that's it.

			`### Linux`

			`Client mode:`

			`For simple testing do:`

			`$ lokinet`

			`On systemd based distros you can persist it in the background:`

			`# systemctl enable --now lokinet-client`


			`Relay mode:`

			`you can participate as a relay node trivially (for now).`

			`On systemd based linux distros do:`

			`# systemctl enable --now lokinet-relay`

			`Alternatively:`

			`# mkdir /usr/local/lokinet`
			`# cd /usr/local/lokinet`
			`# lokinet --genconf daemon.ini`
			`# lokinet --check daemon.ini`
			`# lokinet /usr/local/lokinet/daemon.ini`