PHPackages                             johannschopplich/kirby-deploy-trigger - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [DevOps & Deployment](/categories/devops)
4. /
5. johannschopplich/kirby-deploy-trigger

ActiveKirby-plugin[DevOps & Deployment](/categories/devops)

johannschopplich/kirby-deploy-trigger
=====================================

Kirby Panel plugin to trigger deployments on any platform

1.0.6(1y ago)17823↓100%MITPHP

Since Jan 5Pushed 1y ago1 watchersCompare

[ Source](https://github.com/johannschopplich/kirby-deploy-trigger)[ Packagist](https://packagist.org/packages/johannschopplich/kirby-deploy-trigger)[ Docs](https://github.com/johannschopplich/kirby-deploy-trigger#readme)[ Fund](https://kirby.tools)[ RSS](/packages/johannschopplich-kirby-deploy-trigger/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (7)Dependencies (3)Versions (8)Used By (0)

[![Kirby Deploy Trigger screenshot](./.github/kirby-deploy-trigger.png)](./.github/kirby-deploy-trigger.png)

Kirby Deploy Trigger
====================

[](#kirby-deploy-trigger)

A Kirby Panel view button to trigger deployments on any CI/CD service, such as [Vercel](https://vercel.com/docs/deployments/deploy-hooks), [Netlify](https://docs.netlify.com/configure-builds/build-hooks/), or GitHub Actions.

This is especially useful when you want to trigger a deployment after updating the content in the Panel from your headless Kirby setup. The button sends a request to the specified URL, which can be used to trigger a deployment on your CI/CD service.

Requirements
------------

[](#requirements)

- Kirby 4 or Kirby 5

Kirby is not free software. However, you can try Kirby and the Starterkit on your local machine or on a test server as long as you need to make sure it is the right tool for your next project. … and when you're convinced, [buy your license](https://getkirby.com/buy).

Installation
------------

[](#installation)

### Composer

[](#composer)

```
composer require johannschopplich/kirby-deploy-trigger
```

### Download

[](#download)

Download and copy this repository to `/site/plugins/kirby-deploy-trigger`.

Getting Started
---------------

[](#getting-started)

### Webhook Setup

[](#webhook-setup)

Create a webhook in your CI/CD service to listen for incoming requests. The webhook URL is the URL you need to specify in the `johannschopplich.deploy-trigger.deployUrl` option in the `config.php` file:

```
# /site/config/config.php
return [
    'johannschopplich.deploy-trigger' => [
        'deployUrl' => 'https://api.example.com/deploy',
    ]
];
```

Tip

The `deployUrl` is sent as a POST request by default. You can change the request method with the [`requestOptions`](#configuration) option.

### Blueprint Setup

[](#blueprint-setup)

Kirby 5 introduces new extensions that allow you to add custom view buttons to most Panel views (e.g. page, site, or file). The Deploy Trigger plugin provides a button that can be added alongside the default buttons, such as the preview button or the language dropdown.

To add the `deploy-trigger` button to a particular view, set the `buttons` option in the corresponding blueprint. The following example shows how to reference the default buttons and add the `deploy-trigger` button to the `site` blueprint:

```
# /site/blueprints/site.yml
buttons:
  - deploy-trigger # Re-order the button as needed
  - preview
```

This way, you can reference the default buttons and decide where to place the `deploy-trigger` button.

Tip

Kirby 4 does not support custom view buttons, but the `deploy-trigger` button has been backported 🎉. It is always prepended to the default buttons and cannot be moved.

Configuration
-------------

[](#configuration)

Each configuration option is available in the `config.php` file.

The following table lists all available options:

OptionDefaultDescription`deployUrl``null`The URL to trigger the deployment.`requestOptions``[]`Additional headers or a specific method to send the request.Cookbook
--------

[](#cookbook)

### Trigger a Vercel Deployment

[](#trigger-a-vercel-deployment)

To create a Deploy Hook for your project, make sure your project is [connected to a Git repository](https://vercel.com/docs/projects/overview#git).

Once your project is connected, navigate to its **Settings** page and then select the **Git** menu item.

In the "Deploy Hooks" section, choose a name for your Deploy Hook and select the branch that will be deployed when the generated URL is requested.

[![Create Vercel deploy hooks](./.github/vercel-deploy-hooks-light.png)](https://vercel.com/docs/deployments/deploy-hooks)

After submitting the form, you will see a URL that you can copy and use as the `deployUrl` option in the `config.php` file.

License
-------

[](#license)

[MIT](./LICENSE) License © 2025-PRESENT [Johann Schopplich](https://github.com/johannschopplich)

###  Health Score

34

—

LowBetter than 77% of packages

Maintenance47

Moderate activity, may be stable

Popularity26

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity43

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~15 days

Recently: every ~23 days

Total

7

Last Release

399d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/b9be5bf8dd3a36f63c00f92a115f1109567745fb3b068617341ffc8a90755d6c?d=identicon)[johannschopplich](/maintainers/johannschopplich)

---

Top Contributors

[![johannschopplich](https://avatars.githubusercontent.com/u/27850750?v=4)](https://github.com/johannschopplich "johannschopplich (26 commits)")

---

Tags

kirby-cmskirby-pluginkirby4kirby5deploymentkirbyvercel

### Embed Badge

![Health badge](/badges/johannschopplich-kirby-deploy-trigger/health.svg)

```
[![Health](https://phpackages.com/badges/johannschopplich-kirby-deploy-trigger/health.svg)](https://phpackages.com/packages/johannschopplich-kirby-deploy-trigger)
```

###  Alternatives

[timokoerber/laravel-one-time-operations

Run operations once after deployment - just like you do it with migrations!

6481.7M11](/packages/timokoerber-laravel-one-time-operations)[andres-montanez/magallanes

The Deployment Tool for PHP Applications

6901.1M6](/packages/andres-montanez-magallanes)[dg/ftp-deployment

A tool for automated deployment of web applications to an FTP server.

615845.5k8](/packages/dg-ftp-deployment)[easycorp/easy-deploy-bundle

The easiest way to deploy Symfony applications

468310.2k](/packages/easycorp-easy-deploy-bundle)[jalogut/magento2-deployer-plus

Magento 2 deployment tool based on deployer.org

201415.5k](/packages/jalogut-magento2-deployer-plus)[oblik/kirby-git

Shows you Git changes in the Kirby panel and allows you to add/commit/push them, manually or automatically.

8310.4k](/packages/oblik-kirby-git)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)