TLS

Connect to a broker with TLS

You can secure communication between your client applications and the Zeebe broker cluster using TLS (Transport Layer Security). This needs to be enabled in the broker, or in an reverse proxy, to use.

By default, the broker does not secure the client connections with TLS, and the Node client does not use TLS for the connection.

To enable TLS with the Node client and connect to a broker secured with TLS, set the option useTLS to true:

    import { ZBClient } from 'zeebe-node'

// With the default, or a gateway address from the environment
const zbc = new ZBClient({
  useTLS: true
})

// With a gateway address provided in the code
const zbc = new ZBClient(gatewayAddress, {
  useTLS: true
})
    

    const { ZBClient } = require('zeebe-node')

// With the default, or a gateway address from the environment
const zbc = new ZBClient({
  useTLS: true
})

// With a gateway address provided in the code
const zbc = new ZBClient(gatewayAddress, {
  useTLS: true
})

    Environmentalizing TLS

    To enable TLS with the Node client and connect to a broker secured with TLS, set the environment variable ZEEBE_SECURE_CONNECTION:

    ZEEBE_SECURE_CONNECTION=true