mirror of
https://github.com/mainflux/mainflux.git
synced 2025-04-26 13:48:53 +08:00
83ff4e12ea
* Change service Default ports Updated ports: - auth http 9000 - auth grpc 7000 - provision http 9001 - things http 9002 - things auth http 9003 - things auth grpc 7001 - twins http 9004 - users http 9005 - bootstrap http 9006 - cassandra-reader http 9007 - cassandra-writer http 9008 - influxdb-reader http 9009 - influxdb-writer http 9010 - lora http 9011 - mongodb reader http 9012 - mongodb writer http 9013 - postgres-reader http 9014 - postgrs-writer http 9015 - smpp-notifier http 9016 - smtp-notifier http 9017 - timescale-reader http 9018 - timescale-writer http 9019 Signed-off-by: SammyOina <sammyoina@gmail.com> * change default service ports on env and sh Signed-off-by: SammyOina <sammyoina@gmail.com> * change things url default port Signed-off-by: SammyOina <sammyoina@gmail.com> * change default ports order by importance - auth http 9000 - auth grpc 7000 - things http 9001 - things auth http 9002 - things auth grpc 7001 - users http 9003 - cassandra-reader http 9004 - cassandra-writer http 9005 - influxdb-reader http 9006 - influxdb-writer http 9007 - mongodb reader http 9008 - mongodb writer http 9009 - postgres-reader http 9010 - postgres-writer http 9011 - timescale-reader http 9012 - timescale-writer http 9013 - bootstrap http 9014 - smpp-notifier http 9015 - smtp-notifier http 9016 - provision http 9017 - lora http 9018 - twins http 9019 Signed-off-by: SammyOina <sammyoina@gmail.com> * lower port number in auth service Signed-off-by: SammyOina <sammyoina@gmail.com> * change things and users port - things 9000 - things auth 9001 - things auth grpc 7000 - users 9002 Signed-off-by: SammyOina <sammyoina@gmail.com> * update documentaton to new port numbers Signed-off-by: SammyOina <sammyoina@gmail.com> * update test and metrics Signed-off-by: SammyOina <sammyoina@gmail.com> * update host on metrics Signed-off-by: SammyOina <sammyoina@gmail.com> * resolving conflics Signed-off-by: SammyOina <sammyoina@gmail.com> * set http adapter port to :80 Signed-off-by: SammyOina <sammyoina@gmail.com> * reassign http port on metrics to :80 Signed-off-by: SammyOina <sammyoina@gmail.com> * reassign http adapter port Signed-off-by: SammyOina <sammyoina@gmail.com> * set http adapter port to 8008 Signed-off-by: SammyOina <sammyoina@gmail.com> * document http adapter default port Signed-off-by: SammyOina <sammyoina@gmail.com> --------- Signed-off-by: SammyOina <sammyoina@gmail.com>
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 | 8190 |
| MF_BROKER_URL | Message broker instance URL | nats://localhost:4222 |
| MF_WS_ADAPTER_LOG_LEVEL | Log level for the WS Adapter | info |
| MF_WS_ADAPTER_CLIENT_TLS | Flag that indicates if TLS should be turned on | false |
| MF_WS_ADAPTER_CA_CERTS | Path to trusted CAs in PEM format | |
| MF_JAEGER_URL | Jaeger server URL | localhost:6831 |
| 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 |
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_Broker_URL=[Message broker instance URL] \
MF_WS_ADAPTER_PORT=[Service WS port] \
MF_WS_ADAPTER_LOG_LEVEL=[WS adapter log level] \
MF_WS_ADAPTER_CLIENT_TLS=[Flag that indicates if TLS should be turned on] \
MF_WS_ADAPTER_CA_CERTS=[Path to trusted CAs in PEM format] \
MF_JAEGER_URL=[Jaeger server URL] \
MF_THINGS_AUTH_GRPC_URL=[Things service Auth gRPC URL] \
MF_THINGS_AUTH_GRPC_TIMEOUT=[Things service Auth gRPC request timeout in seconds] \
$GOBIN/mainflux-ws
Usage
For more information about service capabilities and its usage, please check out the WebSocket paragraph in the Getting Started guide.