Updated Configuration (markdown)

Fabio Manganiello 2018-01-08 22:00:39 +01:00
parent 501e49572b
commit d5e751152f
1 changed files with 13 additions and 4 deletions

@ -1,4 +1,5 @@
* [Backends](#backends)
* [HTTP service configuration](#http-service-configuration)
* [PushBullet](#pushbullet-configuration)
* [Apache Kafka](#apache-kafka-configuration)
* [Local backend](#local-backend-configuration)
@ -11,17 +12,25 @@
* [Belkin WeMo Switch](#belkin-wemo-switch)
* [Text-to-Speech](#text-to-speech-support)
* [Shell plugin](#shell-plugin)
* [HTTP requests plugin](#http-requests-plugin)
* [Database plugin](#database-plugin)
* [Procedures](#procedures)
* [Event Hooks](#event-hooks)
* [Mobile notification mirroring](#mobile-notification-mirroring)
* [Include directive](#include-directive)
Copy `/etc/platypush/config.example.yaml` to `/etc/platypush/config.yaml` (system-wise settings) or `~/.config/platypush/config.yaml` (user-wise settings).
Some configuration snippets:
# device_id
## device_id
Each target device is identified by a unique device_id in the messages sent over your account. The device_id is the hostname by default, unless a different value is set in config.yaml at the root level.
```yaml
device_id: some_custom_name
```
# Backends
Platypush comes by default with an HTTP service as a backend, a [PushBullet](https://www.pushbullet.com/) backend, an [Apache Kafka](https://kafka.apache.org/) backend, and a (quite unstable) local backend based on fifos. Backend configurations start with `backend.` in the `config.yaml`.
@ -265,7 +274,7 @@ Procedures are lists of actions that will be executed by Platypush.
A procedure can be run:
## Synchronously
## Synchronous
Configuration name starting with `procedure.sync.`.
@ -305,7 +314,7 @@ procedure.sync.turn_all_lights_on:
light: ${light['name']}
```
## Asynchronously
## Asynchronous
Configuration name starting with `procedure.async.`.
@ -426,4 +435,4 @@ To keep the configuration neat and manageable, and/or keep some configuration pa
include:
- include/backends.yaml
- include/assistant_common.yaml
```
```