1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
|
*******************
User guide
*******************
This guide describes how to use receptor in multiple environments and uses the following terms:
.. glossary::
backend
A type of connection that receptor nodes can pass traffic over. Current backends include TCP, UDP and websockets.
backend peers
A node connected to another through receptor backends.
control node
A node running the receptor control service.
control service
A built-in service that usually runs under the name `control`. Used to report status and to launch and monitor work.
netceptor
The component of receptor that handles all networking functionality.
netceptor peers
A receptor node directly connected to another receptor node.
node
A single running instance of receptor.
node ID
An arbitrary string identifying a single node, analogous to an IP address.
receptor
The receptor application taken as a whole, which typically runs as a daemon.
receptorctl
A user-facing command line used to interact with receptor, typically over a Unix domain socket.
workceptor
The component of receptor that handles work units.
.. toctree::
:maxdepth: 2
basic_usage
configuration_options
connecting_nodes
edge_networks
firewall
interacting_with_nodes
k8s
tls
workceptor
|