Add fireboard to top level README
This commit is contained in:
parent
d364abf870
commit
92cabcd323
|
@ -176,6 +176,7 @@ For documentation on the latest development code see the [documentation index][d
|
||||||
* [file](./plugins/inputs/file)
|
* [file](./plugins/inputs/file)
|
||||||
* [filestat](./plugins/inputs/filestat)
|
* [filestat](./plugins/inputs/filestat)
|
||||||
* [filecount](./plugins/inputs/filecount)
|
* [filecount](./plugins/inputs/filecount)
|
||||||
|
* [fireboard](/plugins/inputs/fireboard)
|
||||||
* [fluentd](./plugins/inputs/fluentd)
|
* [fluentd](./plugins/inputs/fluentd)
|
||||||
* [github](./plugins/inputs/github)
|
* [github](./plugins/inputs/github)
|
||||||
* [graylog](./plugins/inputs/graylog)
|
* [graylog](./plugins/inputs/graylog)
|
||||||
|
|
|
@ -1,15 +1,11 @@
|
||||||
# Fireboard Input Plugin
|
# Fireboard Input Plugin
|
||||||
|
|
||||||
The fireboard plugin gathers the real time temperature data from fireboard
|
The fireboard plugin gathers the real time temperature data from fireboard
|
||||||
thermometers. In order to use this input plugin, you'll need to sign up
|
thermometers. In order to use this input plugin, you'll need to sign up to use
|
||||||
to use their REST API, you can find more information on their website
|
the [Fireboard REST API](https://docs.fireboard.io/reference/restapi.html).
|
||||||
here [https://docs.fireboard.io/reference/restapi.html]
|
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
|
||||||
This section contains the default TOML to configure the plugin. You can
|
|
||||||
generate it using `telegraf --usage <plugin-name>`.
|
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[[inputs.fireboard]]
|
[[inputs.fireboard]]
|
||||||
## Specify auth token for your account
|
## Specify auth token for your account
|
||||||
|
@ -22,9 +18,9 @@ generate it using `telegraf --usage <plugin-name>`.
|
||||||
|
|
||||||
#### auth_token
|
#### auth_token
|
||||||
|
|
||||||
In lieu of requiring a username and password, this plugin requires the
|
In lieu of requiring a username and password, this plugin requires an
|
||||||
authToken that you can generate using the Fireboard REST API as described
|
authentication token that you can generate using the [Fireboard REST
|
||||||
in their docs [https://docs.fireboard.io/reference/restapi.html#Authentication]
|
API](https://docs.fireboard.io/reference/restapi.html#Authentication).
|
||||||
|
|
||||||
#### url
|
#### url
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue