PHPackages                             jalendport/craft-updatechecker - 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. [Utility & Helpers](/categories/utility)
4. /
5. jalendport/craft-updatechecker

ActiveCraft-plugin[Utility & Helpers](/categories/utility)

jalendport/craft-updatechecker
==============================

Automated update checker that notifies you of any pending updates

1.3.0(6y ago)125.7k1[1 issues](https://github.com/jalendport/craft-updatechecker/issues)[1 PRs](https://github.com/jalendport/craft-updatechecker/pulls)1MITPHPCI failing

Since May 1Pushed 2y ago1 watchersCompare

[ Source](https://github.com/jalendport/craft-updatechecker)[ Packagist](https://packagist.org/packages/jalendport/craft-updatechecker)[ RSS](/packages/jalendport-craft-updatechecker/feed)WikiDiscussions master Synced 3w ago

READMEChangelog (6)Dependencies (1)Versions (8)Used By (1)

[![icon](src/icon.svg)](src/icon.svg)

[![](https://camo.githubusercontent.com/cbd77fd82e521d9fe483a3d0bce47c9e207dfe89dfa7fd0c9364c43dc18645fb/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f6a616c656e64706f72742f63726166742d757064617465636865636b65722e7376673f7374796c653d666c6174)](https://camo.githubusercontent.com/cbd77fd82e521d9fe483a3d0bce47c9e207dfe89dfa7fd0c9364c43dc18645fb/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f6a616c656e64706f72742f63726166742d757064617465636865636b65722e7376673f7374796c653d666c6174)[![](https://camo.githubusercontent.com/9ddcf7cf1041e3dfe2ab694a16f96bbd910a45bc3b8aecb4f851e1b7406c2397/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6a616c656e64706f72742f63726166742d757064617465636865636b65722e7376673f7374796c653d666c6174)](https://camo.githubusercontent.com/9ddcf7cf1041e3dfe2ab694a16f96bbd910a45bc3b8aecb4f851e1b7406c2397/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6a616c656e64706f72742f63726166742d757064617465636865636b65722e7376673f7374796c653d666c6174)

Update Checker plugin for Craft CMS 3
=====================================

[](#update-checker-plugin-for-craft-cms-3)

Automated update checker that notifies you of any pending updates.

Support Open Source
-------------------

[](#support-open-source)

This plugin is licensed under an MIT license, which means that it's completely free open source software, and you can use it for whatever and however you wish. If you find this plugin useful, please consider supporting my work by buying me a beer 🍻😊

[![Beerpay](https://camo.githubusercontent.com/c3d4d21460c06b2a83a1e2c6644546bae16db77a5dd162e80cd935f75451e37f/68747470733a2f2f626565727061792e696f2f6a616c656e64706f72742f63726166742d757064617465636865636b65722f62616467652e7376673f7374796c653d626565722d737175617265)](https://beerpay.io/lukeyouell/craft-updatechecker)

[![Screenshot](resources/img/screenshot-slack.png)](resources/img/screenshot-slack.png)

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

[](#requirements)

This plugin requires Craft CMS 3.0.0 or later.

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

[](#installation)

To install the plugin, either install via the plugin store or follow these instructions.

1. Open your terminal and go to your Craft project:

    ```
     cd /path/to/project

    ```
2. Then tell Composer to load the plugin:

    ```
     composer require jalendport/craft-updatechecker

    ```
3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Update Checker.

Notification Methods
--------------------

[](#notification-methods)

You can choose from a combination of the following notification methods:

### Email

[](#email)

An email will be sent to a list of comma-separated email addresses.

### Slack

[](#slack)

Notifications will be sent to a Slack Channel of your choosing.

This requires the creation of a [Slack Webhook](https://api.slack.com/incoming-webhooks), which you can do [here](https://my.slack.com/services/new/incoming-webhook/).

Endpoint
--------

[](#endpoint)

### Endpoint URL

[](#endpoint-url)

You can find your endpoint url located in the plugin settings page, which will look like this:

```
https://www.yoursite.co.uk/actions/update-checker/check

```

### Securing Your Endpoint

[](#securing-your-endpoint)

You can secure your endpoint with an access key, which is set in the plugin settings.

After defining your access key you will need to include it in your requests in the form of the following header:

Header NameHeader Value`Access-Key``access-key-value`Cron Job
--------

[](#cron-job)

Update Checker relies on the endpoint being hit on a regular basis, which will require a cron job. If you aren't familiar with setting up cron jobs I highly recommend using a service such as [SetCronJob](https://www.setcronjob.com).

HTTP requests headers:

Header NameHeader ValueRequired`Accept``application/json`Required`Access-Key``access-key-value`OptionalFeel free to set the cron job to check for updates as often as you like.

Overriding Plugin Settings
--------------------------

[](#overriding-plugin-settings)

If you create a [config file](https://docs.craftcms.com/v3/configuration.html) in your `config` folder called `update-checker.php`, you can override the plugin’s settings in the Control Panel. Since that config file is fully [multi-environment](https://docs.craftcms.com/v3/configuration.html) aware, this is a handy way to have different settings across multiple environments.

Here’s what that config file might look like along with a list of all of the possible values you can override.

```