mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-12 11:56:50 +00:00
Change Mastodon to be setup via the UI (#33917)
* Change Mastodon to be setup via the UI * Add me as a code owner * Apply sentence-style capitalization --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
parent
3aaa530623
commit
9f617cb6ae
@ -470,7 +470,7 @@ source/_integrations/lyric.markdown @timmo001
|
|||||||
source/_integrations/madeco.markdown @starkillerOG
|
source/_integrations/madeco.markdown @starkillerOG
|
||||||
source/_integrations/marantz.markdown @ol-iver @starkillerOG
|
source/_integrations/marantz.markdown @ol-iver @starkillerOG
|
||||||
source/_integrations/martec.markdown @starkillerOG
|
source/_integrations/martec.markdown @starkillerOG
|
||||||
source/_integrations/mastodon.markdown @fabaff
|
source/_integrations/mastodon.markdown @fabaff @andrew-codechimp
|
||||||
source/_integrations/matrix.markdown @PaarthShah
|
source/_integrations/matrix.markdown @PaarthShah
|
||||||
source/_integrations/matter.markdown @home-assistant/matter
|
source/_integrations/matter.markdown @home-assistant/matter
|
||||||
source/_integrations/mealie.markdown @joostlek @andrew-codechimp
|
source/_integrations/mealie.markdown @joostlek @andrew-codechimp
|
||||||
|
@ -1,11 +1,12 @@
|
|||||||
---
|
---
|
||||||
title: Mastodon
|
title: Mastodon
|
||||||
description: Instructions on how to add Instapush notifications to Home Assistant.
|
description: Instructions on how to add Mastodon notifications to Home Assistant.
|
||||||
ha_category:
|
ha_category:
|
||||||
- Notifications
|
- Notifications
|
||||||
ha_release: 0.67
|
ha_release: 0.67
|
||||||
ha_codeowners:
|
ha_codeowners:
|
||||||
- '@fabaff'
|
- '@fabaff'
|
||||||
|
- '@andrew-codechimp'
|
||||||
ha_domain: mastodon
|
ha_domain: mastodon
|
||||||
ha_iot_class: Cloud Push
|
ha_iot_class: Cloud Push
|
||||||
ha_platforms:
|
ha_platforms:
|
||||||
@ -23,47 +24,13 @@ The `mastodon` platform uses [Mastodon](https://joinmastodon.org/) to deliver no
|
|||||||
Go to **Preferences** in the Mastodon web interface, then to **Development** and create a new application.
|
Go to **Preferences** in the Mastodon web interface, then to **Development** and create a new application.
|
||||||
If you want to grant only required accesses, uncheck all checkboxes then check only **read:accounts** and **write:statuses**.
|
If you want to grant only required accesses, uncheck all checkboxes then check only **read:accounts** and **write:statuses**.
|
||||||
|
|
||||||
### Configuration
|
{% include integrations/config_flow.md %}
|
||||||
|
|
||||||
To add Mastodon to your installation, add the following to your {% term "`configuration.yaml`" %} file.
|
## Notifications
|
||||||
{% include integrations/restart_ha_after_config_inclusion.md %}
|
|
||||||
|
|
||||||
```yaml
|
The integration will create a `notify` action matching the name of the integration entry.
|
||||||
# Example configuration.yaml entry
|
|
||||||
notify:
|
|
||||||
- name: NOTIFIER_NAME
|
|
||||||
platform: mastodon
|
|
||||||
access_token: !secret mastodon_access_token
|
|
||||||
client_id: !secret mastodon_client_id
|
|
||||||
client_secret: !secret mastodon_client_secret
|
|
||||||
```
|
|
||||||
|
|
||||||
{% configuration %}
|
### Action usage
|
||||||
name:
|
|
||||||
description: "The optional parameter name allows multiple notifiers to be created. The notifier will bind to the `notify.NOTIFIER_NAME` action."
|
|
||||||
required: false
|
|
||||||
type: string
|
|
||||||
default: notify
|
|
||||||
access_token:
|
|
||||||
description: Your Mastodon access token.
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
client_id:
|
|
||||||
description: Your Mastodon client ID
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
client_secret:
|
|
||||||
description: Your Mastodon client secret.
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
base_url:
|
|
||||||
description: URL of the Mastodon instance to use.
|
|
||||||
required: false
|
|
||||||
type: string
|
|
||||||
default: https://mastodon.social
|
|
||||||
{% endconfiguration %}
|
|
||||||
|
|
||||||
### Usage
|
|
||||||
|
|
||||||
Mastodon is a notify platform, and can be used by calling notify action as described in the [notify documentation](/integrations/notify/). It will toot messages using
|
Mastodon is a notify platform, and can be used by calling notify action as described in the [notify documentation](/integrations/notify/). It will toot messages using
|
||||||
your account. An optional **target** parameter can be given to specify whether your toot will be public, private, unlisted, or direct.
|
your account. An optional **target** parameter can be given to specify whether your toot will be public, private, unlisted, or direct.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user