# User guide

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

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.

node

  A single running instance of receptor.

node ID

  An arbitrary string identifying a single node, analogous to an IP address.

backend

  A type of connection that receptor nodes can pass traffic over. Current backends include TCP, UDP and websockets.

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.

workceptor

  The component of receptor that handles work units.

- Using Receptor
  - Configuring Receptor with the CLI
  - Configuring Receptor with a config file
  - Use Receptor through a container image
- Connecting nodes
  - Configuring backends
- Interacting with nodes
  - ReceptorControl
  - Connect to control service
  - Control service commands
  - Reload
- 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
- Kubernetes work
  - Runtime params
- TLS support
  - Configuring TLS
  - Generating certs
  - Pinned certificates
  - Above the mesh TLS
  - Skip certificate validation
- Firewall Rules
- Support for Edge Networks
  - Configurable-Items