Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NOISSUE - Add config to writers docs #812

Merged
merged 2 commits into from
Aug 1, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .env
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ MF_COAP_ADAPTER_PORT=5683
## Addons Services
### Bootstrap
MF_BOOTSTRAP_LOG_LEVEL=debug
MF_BOOTSTRAP_PORT=8200
MF_BOOTSTRAP_PORT=8202
MF_BOOTSTRAP_DB_PORT=5432
MF_BOOTSTRAP_DB_USER=mainflux
MF_BOOTSTRAP_DB_PASS=mainflux
Expand Down
10 changes: 10 additions & 0 deletions docs/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,16 @@ In order to run these services, core services, as well as the network from the c

Writers provide an implementation of various `message writers`. Message writers are services that consume normalized (in `SenML` format) Mainflux messages and store them in specific data store.

Every writer can filter messages based on channel list that is set in
`channels.toml` configuration file. If you want to listen on all channels,
just pass one element ["*"], otherwise pass the list of channels. Here is
an example:

```toml
[channels]
filter = ["*"]
```

### InfluxDB, InfluxDB-writer and Grafana

From the project root execute the following command:
Expand Down
2 changes: 1 addition & 1 deletion writers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Writers provide an implementation of various `message writers`.
Message writers are services that consume normalized (in `SenML` format)
Mainflux messages and store them in specific data store.

Writers are optional services and are treated as a plugins. In order to
Writers are optional services and are treated as plugins. In order to
run writer services, core services must be up and running. For more info
on the platform core services with its dependencies, please check out
the [Docker Compose][compose] file.
Expand Down
2 changes: 1 addition & 1 deletion writers/cassandra/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ default values.
| MF_CASSANDRA_WRITER_DB_USERNAME | Cassandra DB username | |
| MF_CASSANDRA_WRITER_DB_PASSWORD | Cassandra DB password | |
| MF_CASSANDRA_WRITER_DB_PORT | Cassandra DB port | 9042 |
| MF_CASSANDRA_WRITER_CHANNELS_CONFIG | Configuration file path with channels list | /config/channels.yaml |
| MF_CASSANDRA_WRITER_CHANNELS_CONFIG | Configuration file path with channels list | /config/channels.toml |
## Deployment

```yaml
Expand Down
2 changes: 1 addition & 1 deletion writers/influxdb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ default values.
| MF_INFLUX_WRITER_DB_PORT | Default port of InfluxDB database | 8086 |
| MF_INFLUX_WRITER_DB_USER | Default user of InfluxDB database | mainflux |
| MF_INFLUX_WRITER_DB_PASS | Default password of InfluxDB user | mainflux |
| MF_INFLUX_WRITER_CHANNELS_CONFIG | Configuration file path with channels list | /config/channels.yaml |
| MF_INFLUX_WRITER_CHANNELS_CONFIG | Configuration file path with channels list | /config/channels.toml |

## Deployment

Expand Down
2 changes: 1 addition & 1 deletion writers/mongodb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ default values.
| MF_MONGO_WRITER_DB_NAME | Default MongoDB database name | mainflux |
| MF_MONGO_WRITER_DB_HOST | Default MongoDB database host | localhost |
| MF_MONGO_WRITER_DB_PORT | Default MongoDB database port | 27017 |
| MF_MONGO_WRITER_CHANNELS_CONFIG | Configuration file path with channels list | /config/channels.yaml |
| MF_MONGO_WRITER_CHANNELS_CONFIG | Configuration file path with channels list | /config/channels.toml |

## Deployment

Expand Down
2 changes: 1 addition & 1 deletion writers/postgres/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ default values.
| MF_POSTGRES_WRITER_DB_SSL_CERT | Postgres SSL certificate path | "" |
| MF_POSTGRES_WRITER_DB_SSL_KEY | Postgres SSL key | "" |
| MF_POSTGRES_WRITER_DB_SSL_ROOT_CERT | Postgres SSL root certificate path | "" |
| MF_POSTGRES_WRITER_CHANNELS_CONFIG | Configuration file path with channels list | /config/channels.yaml |
| MF_POSTGRES_WRITER_CHANNELS_CONFIG | Configuration file path with channels list | /config/channels.toml |

## Deployment

Expand Down