mirror of
https://github.com/mainflux/mainflux.git
synced 2025-04-26 13:48:53 +08:00
3e7bac493c
* Initial Commit: Sync Env Veriables With Docker Deployment Signed-off-by: rodneyosodo <blackd0t@protonmail.com> * Sync Env Vars With Master Signed-off-by: rodneyosodo <blackd0t@protonmail.com> * Remove Altprefix Signed-off-by: rodneyosodo <blackd0t@protonmail.com> * Rename HttpPort to HTTPPort Signed-off-by: rodneyosodo <blackd0t@protonmail.com> * Fix envPrefixDB After Rebase Signed-off-by: rodneyosodo <blackd0t@protonmail.com> * Remove Server Parse Signed-off-by: rodneyosodo <blackd0t@protonmail.com> * Add Provision For TLS on CoAP Signed-off-by: rodneyosodo <blackd0t@protonmail.com> * Fix Exit After Defer Signed-off-by: rodneyosodo <blackd0t@protonmail.com> * Remove Unused Function Signed-off-by: rodneyosodo <blackd0t@protonmail.com> * Document Undocumentated Env Variables Signed-off-by: rodneyosodo <blackd0t@protonmail.com> --------- Signed-off-by: rodneyosodo <blackd0t@protonmail.com> Co-authored-by: Drasko DRASKOVIC <drasko.draskovic@gmail.com>
67 lines
3.8 KiB
Markdown
67 lines
3.8 KiB
Markdown
# WebSocket adapter
|
|
|
|
WebSocket adapter provides an [WebSocket](https://en.wikipedia.org/wiki/WebSocket#:~:text=WebSocket%20is%20a%20computer%20communications,protocol%20is%20known%20as%20WebSockets.) 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`](https://github.com/mainflux/mainflux/blob/master/docker/docker-compose.yml#L350-L368) 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:
|
|
|
|
```bash
|
|
# 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](https://mainflux.readthedocs.io/en/latest/messaging/#websocket) in the Getting Started guide.
|