A Kirby 3 plugin to synchronize your content from a source (usually the server) to your local development environment.

This plugin requires Kirby 3, Kirby 3 CLI and PHP 8 or higher to work.

• Kirby 3 Contentsync plugin
  • Table of Contents
  • 1. Installation
    • 1.1 Composer
    • 1.2 Download
    • 1.3 Git submodule
  • 2. Setup
  • 3. Options
    • 3.1 enabledRoots
    • 3.2 Example config entry
  • 4. Usage
  • 5. How does it work
  • 6. Caveats

The recommended way of installing is by using Composer.

composer require zephir/kirby-contentsync

Download and copy this repository to /site/plugins/kirby-contentsync.

git submodule add https://github.com/zephir/kirby-contentsync.git site/plugins/kirby-contentsync

After installation, you need to add the plugin options to your config.

The plugin supports synchronizing the accounts' and content' folders. To support different types of folder structures we use the kirby()->roots() function (hence the name of the option). You can enable/disable either the accounts or content roots.

Default:

[
    'accounts' => true,
    'content' => true
]

'zephir.contentsync' => [
    'source' => 'https://getkirby.com',
    'token' => 'abc123',
    'enabledRoots' => [ // Default, not required
        'accounts' => true,
        'content' => true
    ]
]

After installing, setting up options, and deploying the changes to the server, you can simply run the kirby command:

kirby content:sync

The plugin creates 2 endpoints (routes):

1. /contentsync/files: Returns a list of all files in the enabled roots.
2. /contentsync/file/:fileId: Returns the contents of the requested file.

If you don't set-up a token the endpoints won't work.

Each file returned by files has an ID (sha1 hash of root name + path), a path (relative to kirby root), kirby root name and a checksum of the file contents.

The plugin compares the retrieved file list with a file list of local files. It automatically deletes local files that aren't in the server list, creates the ones that aren't local but in the server list, and updates the ones with different checksums.

It doesn't sync files that haven't changed.

1. Since we download each file individually, it is possible that a WAF / Firewall will block the requests. You can add an exception for the endpoints.
2. Generating the checksum can put a bit of load on the server, especially for large files. But for "normal" websites it should be fine - even if you have several gigabytes of data / many files.

MIT

• Zephir
• Marc Stampfli