Reference: mender-connect

reference

mender-connect is a daemon responsible for handling bidirectional (websocket) communication with the Mender server. The daemon is responsible for implementing a range of troubleshooting features to the device as well as several enhancement to the mender-client.

Configuration

Following is a complete reference of the configuration options for mender-connect along with the default values. The default configuration path is /etc/mender/mender-connect.conf.

{
  "HttpsClient": {
    "Certificate": "",
    "Key": "",
    "SSLEngine": ""
  },
  "ReconnectIntervalSeconds": 5,
  "ServerCertificate": "",
  "Servers": null,
  "ServerURL": "",
  "SkipVerify": false,
  "FileTransfer": {
    "Disable": false
  },
  "MenderClient": {
    "Disable": false
  },
  "PortForward": {
    "Disable": false
  },
  "ShellCommand": "/bin/sh",
  "Sessions": {
    "ExpireAfter": 0,
    "ExpireAfterIdle": 0,
    "MaxPerUser": 1,
    "StopExpired": false
  },
  "Terminal": {
    "Disable": false,
    "Height": 40,
    "Width": 80
  },
  "User": ""
}
  • HttpsClient: Client TLS configuration.
    • Certificate: Path to client certificate.
    • Key: Path to client certificate private key.
    • SSLEngine: OpenSSL cryptographic engine.
  • ReconnectIntervalSeconds: Number of seconds to wait before reconnecting on connection errors.
  • ServerCertificate: Path to a custom certificate trust store. mender-connect will automatically use the system-wide certificate store.
  • Servers: Deprecated List of server URLs to connect with*.
  • ServerURL: Deprecated Server URL to connect with*.
  • SkipVerify: Skip TLS certificate verification.

Servers and ServerURL are deprecated and unused since mender-connect version 1.0.0 - the values are automatically configured by the mender-client.

File transfer configuration

The Mender Troubleshoot add-on package is required. See the Mender features page for an overview of all Mender plans and features.

  • FileTransfer: File transfer configuration options.
    • Disable: Disable file transfer.

Mender client configuration

  • MenderClient: Configuration for mender-client dbus API.
    • Disable: Disable mender-client dbus hooks.

Port forward configuration

The Mender Troubleshoot add-on package is required. See the Mender features page for an overview of all Mender plans and features.

  • PortForward: Configuration for port forwarding
    • Disable: Disable the port forwarding feature.

Remote terminal configuration

The Mender Troubleshoot add-on package is required. See the Mender features page for an overview of all Mender plans and features.

  • ShellCommand: Command executed initiating a new remote terminal session.
  • Sessions: Configuration for remote terminal sessions.
    • StopExpired: Terminate remote terminal sessions after
    • ExpireAfter: Time in seconds until a remote terminal expires.*
    • ExpireAfterIdle Time in seconds until a remote terminal expires after not receiving any traffic.*
    • MaxPerUser: Maximum number of terminal sessions allowed per user.
  • Terminal: Terminal configuration options.
    • Disable: Disable the remote terminal feature.
    • Height: Terminal height in number of characters.
    • Width: Terminal width in number of characters.
  • User: Login user for the remote terminal session.

*ExpireAfter and ExpireAfterIdle are mutually exclusive configuration options, only one option can be configured at the time.

Troubleshooting

By default, mender-connect runs as a systemd service. The easiest way to troubleshoot any issues related to mender-connect is by inspecting the service logs:

journalctl -u mender-connect

If you're having difficulty troubleshooting an issue, don't hesitate to ask our community on Mender Hub.

Found errors? Think you can improve this documentation? Simply click the Edit link at the top of the page, and then the icon on Github to submit changes.