Skip to content

Latest commit

 

History

History
142 lines (104 loc) · 5.3 KB

README.md

File metadata and controls

142 lines (104 loc) · 5.3 KB
Raw

Kirby Git Content

This is a plugin for Kirby that commits and pushes content changes made via the Panel to your git repository.

Screnshot of Panel Area

Requirements

This plugin supports Kirby from version 3.6 (including Kirby 4) and requires git version > 2.24

Usage

You can use this plugin to commit and push changes made via the Panel to your git repository. Either automatically by setting the commit option to true or manually by visiting the panel view and adding a commit.

Setup

Download and configure the Plugin

Installation via composer (recommended)

composer require thathoff/kirby-git-content

Installation via git submodule

git submodule add https://github.com/thathoff/kirby-git-content.git site/plugins/git-content

Manual Installation

Create a new git repository for your content

Create a new git repository where you push your content to init the content repo and push it.

cd content

# include .lock files in .gitignore
echo ".lock" >> .gitignore

# init repo
git init
git add .
git commit -m "Initial Commit"

Remove the content/ folder from your current git repository

cd ..
git rm --cached -r content
git add -A
git commit -m "Move Content Folder to separate repository"

Configuration

By default this plugin just commits changes to the content repository. It’s recommended to setup a cron job which calls yourdomain.com/git-content/push. This will push changes to the remote repository. By using a cron job saving pages in panel is a lot faster then enabling the push option which will push changes after every commit.

This plugin is configurable via Kirby Options. Add the following entires to your config.php.

return [
  // other configuration options
  'thathoff.git-content.commit' => true,
];

Configuration Options

  • path (String): Path to the repository, (default: kirby()->root("content"))
  • pull (Boolean): Pull remote changes first? (default: false)
  • commit (Boolean): Commit your changes? (default: true)
  • push (Boolean): Push your changes to remote? (default: false)
  • commitMessage (String): Configure the template for the commit message (default: :action:(:item:): :url:)
  • cronHooksEnabled (Boolean): Whether /git-content/push and /git-content/pull endpoints are enabled or not. (default: true)
  • cronHooksSecret (String): When set, this secret must be sent with the cronHooks as a get parameter. Note: If you set a secret, only the GET method will work on the webhooks. /git-content/(pull|push)?secret=S0up3rS3c3t
  • displayErrors (Boolean): Display git errors when saving pages (default: true)
  • gitBin (String): Path to the git binary
  • disable (Boolean): If set to true, the plugin won't initialize. (default: false)
  • disableBranchManagement (Boolean): If set to true, the options to create and switch branches are hidden. (default: false)
  • helpText (String): Supply a custom help text shown in the panel UI. (default: null)
  • menuIcon (String): Supply a custom icon for the panel menu item. (default: sitemap)
  • menuLabel (String): Supply a custom label for the panel menu item. (default: Git Content)

Custom Commit Message

By default the commit message is composed from the template :action:(:item:): :url:. So for example a change to the page example will be committed with the message update(page): example. If you would like to change that message you can use the thathoff.git-content.commitMessage option to overwrite the template.

Hooks

The plugin triggers hooks before and after content is pulled or pushed via the interface or the web endpoints. You can use these hooks to trigger other actions, for example to deploy your site after a push or clear caches after a pull.

// site/config/config.php

return [
  // other configuration options
  'hooks' => [
    'thathoff.git-content.push:before' => function () {
      // do something before a push
    },
    'thathoff.git-content.push:after' => function ($response) {
      // do something after a push
    },
    'thathoff.git-content.pull:before' => function () {
      // do something before a pull
    },
    'thathoff.git-content.pull:after' => function ($response) {
      // do something after a pull
    },
  ],
];

Git LFS

Your repository might increase over time, by adding Images, Audio, Video, Binaries, etc. cloning and updating your content repository can take a lot of time. If you are able to use Git LFS you probably should. Here is what the .gitattributes-File could look like:

*.zip filter=lfs diff=lfs merge=lfs -text
*.jpg filter=lfs diff=lfs merge=lfs -text
*.jpeg filter=lfs diff=lfs merge=lfs -text
*.png filter=lfs diff=lfs merge=lfs -text
*.gif filter=lfs diff=lfs merge=lfs -text

Authors

Maintained and developed by Markus Denhoff and Contributors. Initial version by Pascal Küsgen.

Supported by reinorange GmbH.