mirror of
https://github.com/oxen-io/lokinet
synced 2023-12-14 06:53:00 +01:00
update man pages
This commit is contained in:
parent
2d2286b682
commit
37932688c2
22
debian/loki-service-nodes.7
vendored
Normal file
22
debian/loki-service-nodes.7
vendored
Normal file
|
@ -0,0 +1,22 @@
|
||||||
|
.TH "loki-service-nodes" "7" "Dec 3, 2018"
|
||||||
|
|
||||||
|
.SH "NAME"
|
||||||
|
loki-service-nodes \- a note on lokinet's crypto-economics
|
||||||
|
.SH "The Quick Rundown"
|
||||||
|
|
||||||
|
.PP
|
||||||
|
Loki's service nodes are a blockchain based PKI management infrastructure used as a psuedo directory authority for lokinet routers.
|
||||||
|
While using the network as a client costs absolutely nothing,
|
||||||
|
in order to run machines participating in routing one must stake loki tokens,
|
||||||
|
locking tokens for a period of time.
|
||||||
|
During this time the router with the identity key provided in the staking transaction on the loki blockchain will commit to participation for the duration the tokens are locked for.
|
||||||
|
|
||||||
|
.PP
|
||||||
|
Periodically the network performs self-tests on service nodes to ensure service nodes are functional and well behaved.
|
||||||
|
Functional and well behaved service nodes get a block reward for providing routing of traffic.
|
||||||
|
In the event of many test failures the network dergesisters the service node,
|
||||||
|
effectively kicking it from the network as a participating router.
|
||||||
|
|
||||||
|
.PP
|
||||||
|
In conclusion,
|
||||||
|
it is conjectured that the net effect is that well behaved reliable routing infrastucture is incentivesed economically.
|
30
debian/lokinet-bootstrap.1
vendored
Normal file
30
debian/lokinet-bootstrap.1
vendored
Normal file
|
@ -0,0 +1,30 @@
|
||||||
|
.TH "lokinet-bootstrap" "1" "Dec 03, 2018"
|
||||||
|
|
||||||
|
.SH "NAME"
|
||||||
|
lokinet-bootstrap \- lokinet network bootstrap utilitiy
|
||||||
|
.SH "SYNOPSIS"
|
||||||
|
.B lokinet-bootstrap
|
||||||
|
[\fI nodeinfo-url ]
|
||||||
|
.SH "DESCRIPTION"
|
||||||
|
|
||||||
|
.PP
|
||||||
|
This script bootstraps lokinet into the main network by downloading a trusted signed router contact.
|
||||||
|
|
||||||
|
.SH "OPTIONS"
|
||||||
|
|
||||||
|
.IP \fBnodeinfo-url\fR
|
||||||
|
use an alternative url for bootstrap.
|
||||||
|
|
||||||
|
.RE
|
||||||
|
|
||||||
|
.SH "SEE ALSO"
|
||||||
|
|
||||||
|
lokinet configuration. \fBlokinet(1)\fR
|
||||||
|
|
||||||
|
.SH "AUTHOR"
|
||||||
|
This manual page was written by Jeff <\m[blue]\fBjeff@i2p\&.rocks\fR\m[]>
|
||||||
|
.PP
|
||||||
|
Permission is granted to copy, distribute and/or modify this document under the terms of the same license of lokinet source code.
|
||||||
|
.RE
|
||||||
|
See the LICENSE file for more information.
|
||||||
|
|
6
debian/lokinet.1
vendored
6
debian/lokinet.1
vendored
|
@ -1,4 +1,4 @@
|
||||||
.TH "lokinet" "1" "Oct 28, 2018"
|
.TH "lokinet" "1" "Dec 3, 2018"
|
||||||
|
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
lokinet \- Reference implementation for LLARP.
|
lokinet \- Reference implementation for LLARP.
|
||||||
|
@ -49,7 +49,9 @@ The default config file.
|
||||||
|
|
||||||
.RE
|
.RE
|
||||||
.SH "SEE ALSO"
|
.SH "SEE ALSO"
|
||||||
Documentation for lokinet configuration with loki service nodes.
|
|
||||||
|
Documentation for lokinet configuration with loki service nodes. \fBloki-service-nodes(7)\fR
|
||||||
|
|
||||||
.SH "AUTHOR"
|
.SH "AUTHOR"
|
||||||
This manual page was written by Jeff <\m[blue]\fBjeff@i2p\&.rocks\fR\m[]>
|
This manual page was written by Jeff <\m[blue]\fBjeff@i2p\&.rocks\fR\m[]>
|
||||||
.PP
|
.PP
|
||||||
|
|
5
debian/lokinet.install
vendored
5
debian/lokinet.install
vendored
|
@ -1,3 +1,2 @@
|
||||||
lokinet usr/sbin/
|
lokinet usr/bin/
|
||||||
lokinet-rcutil usr/sbin/
|
lokinet-bootstrap usr/bin/
|
||||||
lokinet-bootstrap usr/sbin/
|
|
4
debian/lokinet.manpages
vendored
4
debian/lokinet.manpages
vendored
|
@ -1 +1,3 @@
|
||||||
debian/lokinet.1
|
debian/lokinet.1
|
||||||
|
debian/lokinet-bootstrap.1
|
||||||
|
debian/loki-service-nodes.7
|
2
debian/postinst
vendored
2
debian/postinst
vendored
|
@ -1,3 +1,3 @@
|
||||||
#!/bin/sh -e
|
#!/bin/sh -e
|
||||||
setcap cap_net_admin,cap_net_bind_service=+eip /usr/sbin/lokinet || echo "failed to setcap lokinet"
|
setcap cap_net_admin,cap_net_bind_service=+eip /usr/bin/lokinet || echo "failed to setcap lokinet"
|
||||||
adduser --quiet --system --home /var/lib/lokinet debian-lokinet
|
adduser --quiet --system --home /var/lib/lokinet debian-lokinet
|
||||||
|
|
Loading…
Reference in a new issue