README

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.

Requirements

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

Installation

Kirby CLI

kirby plugin:install scottboms/kirby-promote-button

Git submodule

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

Copy and Paste

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

Configuration

To function, the plugin requires configuration as outlined below.

Required Settings

Add these settings to your /site/config/config.php or /site/config/env.php file. Define which services you wish to use and then replace the CAPITALIZED PLACEHOLDERS with the necessary values.

General

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

Tokens and Passwords

To post to Mastodon, Bluesky or LinkedIn, you will need the necessary authentication tokens or app passwords. Because this information is sensitive, you should not include these 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',
  ],

Optional Settings

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.

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

Blueprint Configuration

There are multiple methods to add View Buttons to your Kirby installation. This plugin includes two distinct View Buttons -- the Promote button to access the core features of this plugin, and the Profile button which currently allows a way to quickly go to a Mastodon profile. The buttons can be added to any page by adding the buttons option in a Page or Site Blueprint.

buttons:
  promote: true
  profile: true

Credits

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

Disclaimer

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.

License

MIT

scottboms / promote-button

Maintainers

Details