mirror of
https://github.com/mainflux/mainflux.git
synced 2025-05-14 19:29:11 +08:00
8a86593dc3
* Fixes #337 Signed-off-by: Jovan Kostovski <chombium@gmail.com> * added create table if not exists Signed-off-by: Jovan Kostovski <chombium@gmail.com> * added test target in sync with Semaphore CI Signed-off-by: Jovan Kostovski <chombium@gmail.com> * added warning about the possible data loss Signed-off-by: Jovan Kostovski <chombium@gmail.com>
58 lines
1.8 KiB
Markdown
58 lines
1.8 KiB
Markdown
# 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_PORT | Service WS port | 8180 |
|
|
| MF_NATS_URL | NATS instance URL | nats://localhost:4222 |
|
|
| MF_THINGS_URL | Things service URL | localhost:8181 |
|
|
|
|
## Deployment
|
|
|
|
The service is distributed as Docker container. The following snippet provides
|
|
a compose file template that can be used to deploy the service container locally:
|
|
|
|
```yaml
|
|
version: "2"
|
|
services:
|
|
ws:
|
|
image: mainflux/ws:[version]
|
|
container_name: [instance name]
|
|
ports:
|
|
- [host machine port]:[configured port]
|
|
environment:
|
|
MF_THINGS_URL: [Things service URL]
|
|
MF_NATS_URL: [NATS instance URL]
|
|
MF_WS_ADAPTER_PORT: [Service WS port]
|
|
```
|
|
|
|
To start the service outside of the container, execute the following shell script:
|
|
|
|
```bash
|
|
# download the latest version of the service
|
|
go get github.com/mainflux/mainflux
|
|
|
|
cd $GOPATH/src/github.com/mainflux/mainflux
|
|
|
|
# compile the ws
|
|
make ws
|
|
|
|
# copy binary to bin
|
|
make install
|
|
|
|
# set the environment variables and run the service
|
|
MF_THINGS_URL=[Things service URL] MF_NATS_URL=[NATS instance URL] MF_WS_ADAPTER_PORT=[Service WS port] $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/getting-started/#websocket) in the Getting Started guide.
|