A customizable View Button for Kirby 5 that builds on Bastian's demo from the Kirby 5 Release Show adding missing functionality and configuration settings for Mastodon, Bluesky, and LinkedIn as well as other user-experience enhancements.

This plugin requires Kirby 5.x and newer. It will not work with earlier versions of Kirby.

kirby plugin:install scottboms/kirby-promote-button

git submodule add https://github.com/scottboms/kirby-promote-button.git site/plugins/promote-button

1. Download the contents of this repository as Zip file.
2. Rename the extracted folder to promote-button and copy it into the site/plugins/ directory in your project.

To function, the plugin requires configuration as outlined below.

You can place these in /site/config/config.php or /site/config/env.php

return [
  'scottboms.promote' => [
    'services' => [
      'mastodon', 'bluesky', 'linkedin'
    ],
    'mastodon' => [
      'url' => 'MASTODON_HOST', // e.g. https://mastodon.social
    ],
    'bluesky' => [
      'base_url' => 'BLUESKY_HOST', // e.g. https://bsky.social
      'handle' => 'USERNAME', // e.g. example.bsky.social‬
    ]
  ],
]

To post to Mastodon, Bluesky or LinkedIn, you will need the necessary authentication tokens or app passwords. Because this information is sensitive, it's recommended that you do not include these specific settings in your /site/config/config.php file and instead place them in the env.php config file which should be added to a .gitignore file to avoid sharing this info publicly.

<?php
return [
  'scottboms.promote.mastodon.token' => 'MASTODON_API_TOKEN',
  'scottboms.promote.bluesky.password' => 'BLUESKY_APP_PASSWORD',
  'scottboms.promote.linkedin.token' => 'LINKEDIN_OAUTH_TOKEN',
],

If you run your Kirby site locally, the Promote button will function but page urls added to the dialog will use the local hostname (e.g. localhost) which isn't very helpful when posting to public services. You can override this behaviour by setting host_url in the configuration.

'scottboms.promote' => [
  'host_url' => 'SHARED_LINK_HOST', // e.g. https://example.com
]

There are multiple methods to add View Buttons to your Kirby installation. To add and configure the look of this button, it can be added to any page by adding the buttons option in the page blueprint.

buttons:
  promote: true

• Original Concept and Starting Points: Bastian Allgeier
• Supported Services: Mastodon, Bluesky, LinkedIn

This plugin is provided "as is" with no guarantee. Use it at your own risk and always test before using it in a production environment. If you identify an issue, typo, etc, please create a new issue so I can investigate.

MIT