webhooks

Webhooks

Webhooks service provides forwarding received messages to other platforms.

Configuration

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

Deployment

The service is distributed as a Docker container. The following snippet provides a compose file template that can be used to deploy the service container locally:

version: "3"
services:
  webhooks:
    image: mainfluxlabs/webhooks:[version]
    container_name: [instance name]
    ports:
      - [host machine port]:[configured HTTP port]
    environment:
      MF_WEBHOOKS_LOG_LEVEL: [Webhooks log level]
      MF_BROKER_URL: [Message broker URL]
      MF_WEBHOOKS_DB_HOST: [Database host address]
      MF_WEBHOOKS_DB_PORT: [Database host port]
      MF_WEBHOOKS_DB_USER: [Database user]
      MF_WEBHOOKS_DB_PASS: [Database password]
      MF_WEBHOOKS_DB: [Name of the database used by the service]
      MF_WEBHOOKS_HTTP_PORT: [Service HTTP port]
      MF_WEBHOOKS_SERVER_CERT: [String path to server cert in pem format]
      MF_WEBHOOKS_SERVER_KEY: [String path to server key in pem format]
      MF_JAEGER_URL: [Jaeger server URL]
      MF_THINGS_AUTH_GRPC_URL: [Things auth service gRPC URL]
      MF_THINGS_AUTH_GRPC_TIMEOUT: [Things auth service gRPC request timeout in seconds]

To start the service outside of the container, execute the following shell script:

# download the latest version of the service
go get github.com/MainfluxLabs/mainflux

cd $GOPATH/src/github.com/MainfluxLabs/mainflux

# compile the webhooks
make webhooks

# copy binary to bin
make install

# set the environment variables and run the service
MF_WEBHOOKS_LOG_LEVEL=[Webhooks log level]
MF_WEBHOOKS_DB_HOST=[Database host address]
MF_WEBHOOKS_DB_PORT=[Database host port]
MF_WEBHOOKS_DB_USER=[Database user]
MF_WEBHOOKS_DB_PASS=[Database password]
MF_WEBHOOKS_DB=[Name of the database used by the service]
MF_THINGS_DB_SSL_MODE=[SSL mode to connect to the database with]
MF_THINGS_DB_SSL_CERT=[Path to the PEM encoded certificate file]
MF_THINGS_DB_SSL_KEY=[Path to the PEM encoded key file]
MF_THINGS_DB_SSL_ROOT_CERT=[Path to the PEM encoded root certificate file]
MF_WEBHOOKS_HTTP_PORT=[Service HTTP port]
MF_WEBHOOKS_AUTH_GRPC_PORT=[Webhooks service Auth gRPC port]
MF_WEBHOOKS_SERVER_CERT=[String path to server cert in pem format]
MF_WEBHOOKS_SERVER_KEY=[String path to server key in pem format]
MF_JAEGER_URL=[Jaeger server URL]
MF_AUTH_GRPC_URL=[Auth service gRPC URL]
MF_AUTH_GRPC_TIMEOUT=[Auth service gRPC request timeout in seconds]
$GOBIN/mainflux-kit

Usage

For more information about service capabilities and its usage, please check out the API documentation.