# User guide

This guide describes how to use receptor in multiple environments and uses the following terms:

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.

- Using Receptor
  - Using the Receptor CLI
  - Configuring Receptor with a config file
  - Use Receptor through a container image
- Receptor Configuration Options
  - Control Services
  - Log level
  - Qlog
  - Node
  - TLS Clients
  - TLS Servers
  - TCP listeners
  - TCP Peers
  - UDP Listeners
  - UDP Peers
  - Websocket Listeners
  - Websocket Peers
  - IP Routers
  - TCP Clients
  - TCP Servers
  - UDP Clients
  - UDP Servers
  - Unix Socket Clients
  - Unix Socket Servers
  - Work Commands
  - Work Kubernetes
  - Kubernetes Environment Variables
  - Work Python
  - Work Signing
  - Work Verification
  - Certificate Authority Initialization
  - Create Certificate Requests
  - Sign Request and Produce Certificate
- Connecting nodes
  - Configuring backends
- Support for Edge Networks
  - Configurable-Items
- Firewall Rules
- Interacting with nodes
  - ReceptorControl
  - Connect to control service
  - Control service commands
  - Reload
- Kubernetes work
  - Runtime params
- TLS support
  - Configuring TLS
  - Generating certs
  - Pinned certificates
  - Above the mesh TLS
  - Skip certificate validation
- Workceptor
  - Configuring work commands
  - Local work
  - Work results
  - Remote work
  - Payload
  - Runtime Parameters
  - Work list
  - Work cancel
  - Work release
  - Work force-release
  - States
  - Signed work
  - Units on disk