Download the PHP package muyaedward/wbapp-updater without Composer
On this page you can find all versions of the php package muyaedward/wbapp-updater. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download muyaedward/wbapp-updater
More information about muyaedward/wbapp-updater
Files in muyaedward/wbapp-updater
Package wbapp-updater
Short Description Providing an auto-updating functionality for your self-hosted Laravel application.
License MIT
Informations about the package wbapp-updater
Laravel Application Self-Updater
This package provides some basic methods to implement a self updating functionality for your Laravel 5 application. Already bundled are some methods to provide a self-update mechanism via Github.
Usually you need this when distributing a self-hosted Laravel application that needs some updating mechanism, as you do not want to bother your lovely users with Git and/or Composer commands ;-)
Install with Composer
There are currently two branches:
master
: Compatible with PHP 7.x5.x
: Compatible with PHP 5.5 + 5.6
Please select the right branch for your PHP version accordingly.
To install the latest version from the master using Composer:
This adds the codedge/laravel-selfupdater package to your composer.json
and downloads the project.
You need to include the service provider in your config/app.php
[1]
and optionally the facade [2]
:
Additionally add the listener to your app/Providers/EventServiceProvider.php
:
Configuration
After installing the package you need to publish the configuration file via
Note: Please enter correct value for vendor and repository name in your config/self-updater.php
if you want to
use Github as source for your updates.
Running artisan commands
Artisan commands can be run before or after the update process and can be configured in config/self-updater.php
:
Example:
Notifications via email
You need to specify a recipient email address and a recipient name to receive
update available notifications.
You can specify these values by adding SELF_UPDATER_MAILTO_NAME
and
SELF_UPDATER_MAILTO_ADDRESS
to your .env
file.
Config name | Description |
---|---|
SELF_UPDATER_MAILTO_NAME | Name of email recipient |
SELF_UPDATER_MAILTO_ADDRESS | Address of email recipient |
SELF_UPDATER_MAILTO_UPDATE_AVAILABLE_SUBJECT | Subject of update available email |
SELF_UPDATER_MAILTO_UPDATE_SUCCEEDED_SUBJECT | Subject of update succeeded email |
Usage
To start an update process, i. e. in a controller, just use:
Of course you can inject the updater via method injection:
Note: Currently the fetching of the source is a synchronous process. It is not run in background.
Using Github
The package comes with a Github source repository type to fetch releases from Github - basically use Github to pull the latest version of your software.
Just make sure you set the proper repository in your config/self-updater.php
file.
Extending and adding new source repository types
You want to pull your new versions from elsewhere? Feel free to create your own source repository type somewhere but keep in mind for the new source repository type:
- It needs to extend AbstractRepositoryType
- It needs to implement SourceRepositoryTypeContract
So the perfect class head looks like
Afterwards you may create your own service provider, i. e. BitbucketUpdaterServiceProvider, with your boot method like so:
Now you call your own update source with:
Contributing
Please see the contributing guide.
Roadmap
Just a quickly sketched roadmap what still needs to be implemented.
Licence
The MIT License (MIT). Please see Licencse file for more information.
All versions of wbapp-updater with dependencies
ext-zip Version *
illuminate/support Version 5.*
guzzlehttp/guzzle Version 6.*