Skip to content

Commit b51a19c

Browse files
authored
docs: Home Assistant Integration (#217)
1 parent 3fc079f commit b51a19c

2 files changed

Lines changed: 44 additions & 0 deletions

File tree

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
notify:
2+
- name: signal
3+
platform: signal_messenger
4+
url: "http://sec-signal-api:8880/auth=API_TOKEN"
5+
number: "+123400001" # tip: use a placeholder instead
6+
recipients:
7+
- "+123400002"
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: Home Assistant
3+
---
4+
5+
# Home Assistant
6+
7+
Instructions on how you can use **Secured Signal API** as a notification service for [Home Assistant](https://github.com/home-assistant/core).
8+
9+
## Setup
10+
11+
### 1. Home Assistant Configuration
12+
13+
To be able to use the Signal Messenger integration in Home Assistant you need to modify or add the following to your `configuration.yml` file:
14+
15+
```yaml
16+
{{{ #://./configuration.yml }}}
17+
```
18+
19+
Here we are taking advantage of the `url` field for adding `/auth=API_TOKEN` in order to use [Path Auth](../usage#auth).
20+
21+
For more detailed configuration instructions read the [official Home Assistant docs](https://www.home-assistant.io/integrations/signal_messenger/).
22+
23+
### 2. Enabling Path Auth
24+
25+
By default [Path Auth](../usage#auth) is disabled, so we first need to enable it in the config by adding `path` to [`auth.methods`](../configuration/auth):
26+
27+
```yaml
28+
api:
29+
auth:
30+
methods: [bearer, basic, body, path]
31+
```
32+
33+
And that's basically it, have fun!
34+
35+
## Sources
36+
37+
- https://www.home-assistant.io/integrations/signal_messenger/

0 commit comments

Comments
 (0)