Mainflux.mainflux/ws/README.md

WebSocket adapter

WebSocket adapter provides an WebSocket API for sending and receiving messages through the platform.

Configuration

The service is configured using the environment variables presented in the following table. Note that any unset variables will be replaced with their default values.

Variable	Description	Default
MF_WS_ADAPTER_LOG_LEVEL	Log level for the WS Adapter	info
MF_WS_ADAPTER_HTTP_HOST	Service WS host
MF_WS_ADAPTER_HTTP_PORT	Service WS port	8190
MF_WS_ADAPTER_HTTP_SERVER_CERT	Service WS server certificate
MF_WS_ADAPTER_HTTP_SERVER_KEY	Service WS server key
MF_THINGS_AUTH_GRPC_URL	Things service Auth gRPC URL	localhost:7000
MF_THINGS_AUTH_GRPC_TIMEOUT	Things service Auth gRPC request timeout in seconds	1s
MF_THINGS_AUTH_GRPC_CLIENT_TLS	Flag that indicates if TLS should be turned on	false
MF_THINGS_AUTH_GRPC_CA_CERTS	Path to trusted CAs in PEM format
MF_BROKER_URL	Message broker instance URL	nats://localhost:4222
MF_JAEGER_URL	Jaeger server URL	http://jaeger:14268/api/traces
MF_SEND_TELEMETRY	Send telemetry to mainflux call home server	true
MF_WS_ADAPTER_INSTANCE_ID	Service instance ID	""

Deployment

The service is distributed as Docker container. Check the ws-adapter service section in docker-compose to see how the service is deployed.

Running this service outside of container requires working instance of the message broker service. To start the service outside of the container, execute the following shell script:

# download the latest version of the service
git clone https://github.com/mainflux/mainflux

cd mainflux

# compile the ws
make ws

# copy binary to bin
make install

# set the environment variables and run the service
MF_WS_ADAPTER_LOG_LEVEL=[WS adapter log level] \
MF_WS_ADAPTER_HTTP_HOST=[Service WS host] \
MF_WS_ADAPTER_HTTP_PORT=[Service WS port] \
MF_WS_ADAPTER_HTTP_SERVER_CERT=[Service WS server certificate] \
MF_WS_ADAPTER_HTTP_SERVER_KEY=[Service WS server key] \
MF_THINGS_AUTH_GRPC_URL=[Things service Auth gRPC URL] \
MF_THINGS_AUTH_GRPC_TIMEOUT=[Things service Auth gRPC request timeout in seconds] \
MF_THINGS_AUTH_GRPC_CLIENT_TLS=[Flag that indicates if TLS should be turned on] \
MF_THINGS_AUTH_GRPC_CA_CERTS=[Path to trusted CAs in PEM format] \
MF_BROKER_URL=[Message broker instance URL] \
MF_JAEGER_URL=[Jaeger server URL] \
MF_SEND_TELEMETRY=[Send telemetry to mainflux call home server] \
MF_WS_ADAPTER_INSTANCE_ID=[Service instance ID] \
$GOBIN/mainflux-ws

Usage

For more information about service capabilities and its usage, please check out the WebSocket paragraph in the Getting Started guide.