Websockets

Gunbot emits certain data through websockets. Limited documentation for this feature is available on the following repository: https://github.com/GuntharDeNiro/Gunthy/#webgui-informations-for-devs-

To change websocket settings, go to Settings > Websocket.

Configuration options for websocket output

Settings descriptions

Below you'll find detailed descriptions of all available parameters for websockets.

Port

Description
Values
Name
Description

Sets the port used for websockets.

Values

Values: numerical, represents a port number

Default value: 5001

Name

Parameter name in config.js: port

Client Port

Description
Values
Name
Description

You can change the client port for third party web interfaces here.

Values

Values: numerical, represents a port number.

Default value: 3000

Name

Parameter name in config.js: clientport

Hostname

Description
Values
Name
Description

The IP address or hostname to be used for WebSockets. Defaults to your localhost. An external IP can also be set.

Values

Values: string, represents an IP-address or hostname

Default value: 127.0.0.1

Name

Parameter name in config.js: hostname