@indiekit/syndicator-mastodon
v1.0.0-beta.16
Published
Mastodon syndicator for Indiekit
Downloads
79
Maintainers
Readme
@indiekit/syndicator-mastodon
Mastodon syndicator for Indiekit.
Installation
npm i @indiekit/syndicator-mastodon
Requirements
A set of Mastodon API keys. You can get these from /settings/applications
on your Mastodon server.
Usage
Add @indiekit/syndicator-mastodon
to your list of plug-ins, specifying options as required:
{
"plugins": ["@indiekit/syndicator-mastodon"],
"@indiekit/syndicator-mastodon": {
"url": "https://mastodon.server",
"user": "username",
"checked": true
}
}
When sharing content to Mastodon using this syndicator, any post visibility setting will be used for the syndicated status:
| Micropub post visibility | Mastodon status visibility | | ------------------------ | -------------------------- | | Public | Public | | Unlisted | Unlisted | | Private | Followers only |
Options
| Option | Type | Description |
| :----------------- | :-------- | :------------------------------------------------------------------------------------------------------------ |
| accessToken
| string
| Your Mastodon access token. Required, defaults to process.env.MASTODON_ACCESS_TOKEN
. |
| url
| string
| Your Mastodon server, i.e. https://mastodon.social
. Required. |
| user
| string
| Your Mastodon username (without the @
). Required. |
| characterLimit
| number
| Maximum number of characters before a post is truncated. Optional, defaults to 500
. |
| checked
| boolean
| Tell a Micropub client whether this syndicator should be enabled by default. Optional, defaults to false
. |
| includePermalink
| boolean
| Always include a link to the original post. Optional, defaults to false
. |