WebSocket adapter provides a WebSocket API for sending and receiving messages through the platform.
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 |
|---|---|---|
| MG_WS_ADAPTER_LOG_LEVEL | Log level for the WS Adapter (debug, info, warn, error) | info |
| MG_WS_ADAPTER_HTTP_HOST | Service WS host | "" |
| MG_WS_ADAPTER_HTTP_PORT | Service WS port | 8190 |
| MG_WS_ADAPTER_HTTP_SERVER_CERT | Path to the PEM encoded server certificate file | "" |
| MG_WS_ADAPTER_HTTP_SERVER_KEY | Path to the PEM encoded server key file | "" |
| MG_THINGS_AUTH_GRPC_URL | Things service Auth gRPC URL | localhost:7000 |
| MG_THINGS_AUTH_GRPC_TIMEOUT | Things service Auth gRPC request timeout in seconds | 1s |
| MG_THINGS_AUTH_GRPC_CLIENT_CERT | Path to the PEM encoded things service Auth gRPC client certificate file | "" |
| MG_THINGS_AUTH_GRPC_CLIENT_KEY | Path to the PEM encoded things service Auth gRPC client key file | "" |
| MG_THINGS_AUTH_GRPC_SERVER_CERTS | Path to the PEM encoded things server Auth gRPC server trusted CA certificate file | "" |
| MG_MESSAGE_BROKER_URL | Message broker instance URL | nats://localhost:4222 |
| MG_JAEGER_URL | Jaeger server URL | http://localhost:4318/v1/traces |
| MG_JAEGER_TRACE_RATIO | Jaeger sampling ratio | 1.0 |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server | true |
| MG_WS_ADAPTER_INSTANCE_ID | Service instance ID | "" |
The service is distributed as Docker container. Check the ws-adapter service section in docker-compose file to see how the service is deployed.
Running this service outside of container requires working instance of the message broker service, things service and Jaeger server. 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/absmach/magistrala
cd magistrala
# compile the ws
make ws
# copy binary to bin
make install
# set the environment variables and run the service
MG_WS_ADAPTER_LOG_LEVEL=info \
MG_WS_ADAPTER_HTTP_HOST=localhost \
MG_WS_ADAPTER_HTTP_PORT=8190 \
MG_WS_ADAPTER_HTTP_SERVER_CERT="" \
MG_WS_ADAPTER_HTTP_SERVER_KEY="" \
MG_THINGS_AUTH_GRPC_URL=localhost:7000 \
MG_THINGS_AUTH_GRPC_TIMEOUT=1s \
MG_THINGS_AUTH_GRPC_CLIENT_CERT="" \
MG_THINGS_AUTH_GRPC_CLIENT_KEY="" \
MG_THINGS_AUTH_GRPC_SERVER_CERTS="" \
MG_MESSAGE_BROKER_URL=nats://localhost:4222 \
MG_JAEGER_URL=http://localhost:14268/api/traces \
MG_JAEGER_TRACE_RATIO=1.0 \
MG_SEND_TELEMETRY=true \
MG_WS_ADAPTER_INSTANCE_ID="" \
$GOBIN/magistrala-wsSetting MG_WS_ADAPTER_HTTP_SERVER_CERT and MG_WS_ADAPTER_HTTP_SERVER_KEY will enable TLS against the service. The service expects a file in PEM format for both the certificate and the key.
Setting MG_THINGS_AUTH_GRPC_CLIENT_CERT and MG_THINGS_AUTH_GRPC_CLIENT_KEY will enable TLS against the things service. The service expects a file in PEM format for both the certificate and the key. Setting MG_THINGS_AUTH_GRPC_SERVER_CERTS will enable TLS against the things service trusting only those CAs that are provided. The service expects a file in PEM format of trusted CAs.
For more information about service capabilities and its usage, please check out the WebSocket section.