Core
Write Protocols v1.x
1

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

HTTP #

Configuration #

The protocol can be configured via the kuzzlerc configuration file, under the server > protocols > http section.

Option Type Description Default
enabled
boolean
Enable/Disable HTTP protocol support true
maxFormFileSize
string
Maximum size of requests sent via http forms 1mb
maxEncodingLayers
integer
Maximum number of encoding layers that can be applied to an http message, using the Content-Encoding header. This parameter is meant to prevent abuses by setting an abnormally large number of encodings, forcing Kuzzle to allocate as many decoders to handle the incoming request 3
allowCompression
boolean
Enable support for compressed requests, using the Content-encoding header. Currently supported compression algorithms: gzip, deflate, identity. Note: "identity" is always an accepted value, even if compression support is disabled true

Configure listening port #

HTTP, WebSocket and Socket.IO protocols share the same underlying server instance. Modifying the listening port will impact all these three protocols.

By default, Kuzzle listens to the 7512 port.

The port can be modified under the server > port section of Kuzzle configuration.

Limitations #

Due to the synchronous nature of the HTTP protocol, real-time messaging is not supported.