Mainflux.mainflux/coap/README.md

# Mainflux CoAP Adapter

Mainflux CoAP adapter provides an [CoAP](http://coap.technology/) API for sending 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_COAP_ADAPTER_PORT       | Service listening port                         | 5683                  |
| MF_NATS_URL                | NATS instance URL                              | nats://localhost:4222 |
| MF_THINGS_URL              | Things service URL                             | localhost:8181        |
| MF_COAP_ADAPTER_LOG_LEVEL  | Service log level                              | error                 |
| MF_COAP_ADAPTER_CLIENT_TLS | Flag that indicates if TLS should be turned on | false                 |
| MF_COAP_ADAPTER_CA_CERTS   | Path to trusted CAs in PEM format              |                       |

## 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:
  adapter:
    image: mainflux/coap:[version]
    container_name: [instance name]
    ports:
      - [host machine port]:[configured port]
    environment:
      MF_COAP_ADAPTER_PORT: [Service HTTP port]
      MF_NATS_URL: [NATS instance URL]
      MF_THINGS_URL: [Things service URL]
      MF_COAP_ADAPTER_LOG_LEVEL: [Service log level]
      MF_COAP_ADAPTER_CLIENT_TLS: [Flag that indicates if TLS should be turned on]
      MF_COAP_ADAPTER_CA_CERTS: [Path to trusted CAs in PEM format]
```

Running this service outside of container requires working instance of the NATS service.
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 http
make coap

# 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_COAP_ADAPTER_PORT=[Service HTTP port] MF_COAP_ADAPTER_LOG_LEVEL=[Service log level] MF_COAP_ADAPTER_CLIENT_TLS=[Flag that indicates if TLS should be turned on] MF_COAP_ADAPTER_CA_CERTS=[Path to trusted CAs in PEM format] $GOBIN/mainflux-coap
```

## Usage

Since CoAP protocol does not support `Authorization` header (option), in order to send CoAP messages,
client valid `authorization` value must be present in `Uri-Query` option.