Options
All Options have to prefixed with: mauricerenck.indieConnector. I recommend the array syntax, for example:
'mauricerenck.indieConnector' => [
'send' => [
'enabled' => true,
]
],
],
This makes things more readable.
General Settings
| Option | Default | Type | Description |
|---|---|---|---|
localhosts |
['localhost','127.0.0.1'] |
array | Set local hosts to prevent sending webmentions and posts when testing on a local machine |
blockedTargets |
array | Array of hosts to block sending webmentions to | |
secret |
'' |
secret | Your secret for webmention.io or the queue |
Database
| Option | Default | Type | Description |
|---|---|---|---|
sqlitePath |
content/.sqlite/ |
string | Relative path to where the sqlite file should be stored (directory must exist) |
disableMigrations |
false |
boolean | Disable automatic migrations (may lead to errors) |
Panel View
| Option | Default | Type | Description |
|---|---|---|---|
stats.enabled |
false |
boolean | Enable Webmention stats in the panel |
stats.doNotTrack |
['fed.brid.gy'] |
array | When sending webmentions, these hosts will not be tracked |
Sending Webmentions
| Option | Default | Type | Description |
|---|---|---|---|
send.enabled |
true |
boolean | Enable sending webmentions |
send.automatically |
true |
boolean | Enable sending webmentions *automatically* on page save |
send.hook.enabled |
false |
boolean | Allow sending webmentions from Kirby hook triggered by other plugins |
send.maxRetries |
3 |
number | How often should indieconnector try to send a mention if it failes |
send.markDeleted |
false |
boolean | When you delete a page, mark it as gone, so webmention targets can get informed about that - Needs a database! |
send.skipSameHost |
true |
boolean | Skip sending webmentions to yourself |
send.allowedTemplates |
array | Only these template are allowed to send webmentions | |
send.blockedTemplates |
array | These templates cannot send webmentions | |
send.url-fields |
['textfield:text', 'layouteditor:layout', 'blockeditor:block'] |
array | Set fieldnames and types to look for urls in |
send.outboxFilename |
indieConnector.json |
string | Change the filename of the processed urls file |
Receiving Webmentions
| Option | Default | Type | Description |
|---|---|---|---|
receive.enabled |
true |
boolean | Enable receiving webmentions |
receive.useHtmlContent |
false |
boolean | Set to true if you want to show html content from the sender (not recommended) |
receive.blockedSources |
array | An array of source URLs to block, remove the path to block the entire host |
Connect Mastodon
| Option | Default | Type | Description |
|---|---|---|---|
mastodon.enabled |
false |
boolean | Enable posting to mastodon on publish |
mastodon.bearer |
secret | Your API Token | |
mastodon.instance-url |
string | Your mastodon instance url | |
mastodon.text-length |
500 |
number | When to trim the text |
mastodon.resizeImages |
0 |
number | Resize images before upload, value in pixel, 0 means disabled |
Connect Bluesky
| Option | Default | Type | Description |
|---|---|---|---|
bluesky.enabled |
false |
boolean | Enable posting to bluesky on publish |
bluesky.handle |
string | Your user handle | |
bluesky.password |
secret | Your bluesky app password | |
bluesky.resizeImages |
800 |
number | Resize images before upload, value in pixel |
Create posts on Mastodon and Bluesky (POSSE)
| Option | Default | Type | Description |
|---|---|---|---|
post.prefereLanguage |
string | Use another language than your default language to use the text from | |
post.usePermalinkUrl |
false |
boolean | Use the permalink URL instead of the page URL |
post.skipUrl |
false |
boolean | NEVER add the URL to the post |
post.skipUrlTemplates |
array | Do not add the url to the post when using the given templates | |
post.textfields |
['description'] |
array | Text source fields for posting elsewhere |
post.keepMarkdown |
false |
boolean | When posting, also send possible markdown |
post.imagefield |
string | Image source field for posting elsewhere, must be one image | |
post.imagealtfield |
alt |
string | Name of the field containing the alt text for the image in your file blueprint |
post.tagsfield |
string | A Kirby tag field to use for hashtags on mastodon and bluesky | |
post.allowedTemplates |
array | Set templates allowed to send webmentions | |
post.blockedTemplates |
array | Block templates from sending webmentions | |
post.automatically |
true |
boolean | Send posts automatically when a page is published |
Collect Responses
| Option | Default | Type | Description |
|---|---|---|---|
responses.enabled |
false |
boolean | Enable collecting responses |
responses.limit |
10 |
number | Number of posts to check for responses |
responses.ttl |
60 |
number | Minutes after which a post URL should be re-checked for responses |
responses.queue.limit |
50 |
number | Number of items to process per run |
Queue
| Option | Default | Type | Description |
|---|---|---|---|
queue.enabled |
false |
boolean | Queue all incoming webmentions before processing them |
queue.retries |
5 |
number | Retry n times to process the Webmention if there is an error |
ActivityPub Alpha
| Option | Default | Type | Description |
|---|---|---|---|
activityPubBridge |
false |
Enable activityPub (experimental) |