Download the PHP package jalendport/craft-updatechecker without Composer
On this page you can find all versions of the php package jalendport/craft-updatechecker. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jalendport/craft-updatechecker
More information about jalendport/craft-updatechecker
Files in jalendport/craft-updatechecker
Package craft-updatechecker
Short Description Automated update checker that notifies you of any pending updates
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package craft-updatechecker
Update Checker plugin for Craft CMS 3
Automated update checker that notifies you of any pending updates.
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 🍻😊
Requirements
This plugin requires Craft CMS 3.0.0 or later.
Installation
To install the plugin, either install via the plugin store or follow these instructions.
-
Open your terminal and go to your Craft project:
cd /path/to/project -
Then tell Composer to load the plugin:
composer require jalendport/craft-updatechecker - In the Control Panel, go to Settings → Plugins and click the “Install” button for Update Checker.
Notification Methods
You can choose from a combination of the following notification methods:
An email will be sent to a list of comma-separated email addresses.
Slack
Notifications will be sent to a Slack Channel of your choosing.
This requires the creation of a Slack Webhook, which you can do here.
Endpoint
Endpoint URL
You can find your endpoint url located in the plugin settings page, which will look like this:
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 Name | Header Value |
|---|---|
Access-Key |
access-key-value |
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.
HTTP requests headers:
| Header Name | Header Value | Required |
|---|---|---|
Accept |
application/json |
Required |
Access-Key |
access-key-value |
Optional |
Feel free to set the cron job to check for updates as often as you like.
Overriding Plugin Settings
If you create a config file 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 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.
Update Checker Roadmap
Some things to do, and ideas for potential features:
- Ability to define which Slack channel to post updates to
Brought to you by Luke Youell
