Skip to content

Latest commit

 

History

History
92 lines (59 loc) · 3.05 KB

readme.md

File metadata and controls

92 lines (59 loc) · 3.05 KB
Raw

Kirby autopublish plugin

Kirby plugin to schedule the automatic publishing of pages (drafts) / unpublishing of pages (listed) on a certain date+time. It is built to work with enabled cache.

Installation

  • unzip master.zip as folder site/plugins/kirby-autopublish or
  • git submodule add https://github.com/bvdputte/kirby-autopublish.git site/plugins/kirby-autopublish or
  • composer require bvdputte/kirby-autopublish

⚠️ Highly recommended to also install the kirby-log plugin, to get page-publication logs.

Usage

  1. autopublish changes the status of a given page to listed on a given time
  2. autounpublish changes the status of a given page to draft on a given time

Setup worker

1. Via Cron

Add the worker file site/plugins/kirby-autopublish/worker.php to cron or similar at the desired interval (.e.g. each minute).

💡 This is the preferred method for setting up kirby-autopublish. ⚠️ There is a demo worker file included in the plugin that should work with the Kirby default folder setup. In case you use a custom folder setup, please copy the worker an adjust the paths to match your installation.

2. Poor man's cron

When cron is not installed on your server, you can fake cron by enabling this in config.php.

Setup field in blueprint

autopublish:
  label: Autopublish on
  type: date
  time: true
  default: now
autounpublish:
  label: Automatically unpublish on
  type: date
  time: true

Options and opinionated defaults

Set in config.php:

Field name

Autopublish searches for a date-field. By default the name is autopublish and autounpublish, but can be changed:

'fieldName' => 'myautopublishfieldname',
'fieldNameUnpublish' => 'myAutoUnpublishFieldName'

Poor man's cron

By default, this is disabled. Enable:

// Enable poor man's cron
'bvdputte.autopublish.poormanscron' => true

The default interval for poor man's cron to check is each minute. Change this to e.g. quarterly:

'bvdputte.autopublish.poormanscron.interval' => 15

Webhook

You can also configure autopublish to run via a webhook:

'bvdputte.autopublish.webhookToken' => 'my-secret-token'

Now you can trigger the autopublish check via https://mydomain.com/kirby-autopublish/my-secret-token.

Disclaimer

This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please create a new issue.

License

MIT

It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.