Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codedge/laravel-selfupdater
This package provides some basic methods to implement a self updating functionality for your Laravel application. Already bundled are some methods to provide a self-update mechanism via Github or some private repository via http.
https://github.com/codedge/laravel-selfupdater
laravel laravel-package laravel-selfupdater php self-updater updater
Last synced: 16 days ago
JSON representation
This package provides some basic methods to implement a self updating functionality for your Laravel application. Already bundled are some methods to provide a self-update mechanism via Github or some private repository via http.
- Host: GitHub
- URL: https://github.com/codedge/laravel-selfupdater
- Owner: codedge
- License: mit
- Created: 2016-07-29T08:22:01.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-03-25T09:42:56.000Z (8 months ago)
- Last Synced: 2024-05-18T17:04:22.374Z (6 months ago)
- Topics: laravel, laravel-package, laravel-selfupdater, php, self-updater, updater
- Language: PHP
- Homepage:
- Size: 704 KB
- Stars: 390
- Watchers: 8
- Forks: 79
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Laravel Application Self-Updater
[](https://packagist.org/packages/codedge/laravel-selfupdater)
[](https://packagist.org/packages/codedge/laravel-selfupdater)
[](https://github.com/codedge/laravel-selfupdater/actions)
[](https://styleci.io/repos/64463948)
[](https://www.codacy.com/app/codedge/laravel-selfupdater?utm_source=github.com&utm_medium=referral&utm_content=codedge/laravel-selfupdater)
[](https://codecov.io/gh/codedge/laravel-selfupdater)
This package provides some basic methods to implement a self updating
functionality for your Laravel application.
**Supported update provider:**
- GitHub
- Gitlab
- Gitea
- Http-based archives
Usually you need this when distributing a self-hosted Laravel application
that needs some updating mechanism without [Composer](https://getcomposer.org/).
## Install
To install the latest version from the master using [Composer](https://getcomposer.org/):
```sh
composer require codedge/laravel-selfupdater
```
## Configuration
After installing the package you need to publish the configuration file via
```sh
php artisan vendor:publish --provider="Codedge\Updater\UpdaterServiceProvider"
```
**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.
### Setting the currently installed version
Before starting an update, make sure to set the version installed correctly.
You're responsible to set the current version installed, either in the config file or better via the env variable `SELF_UPDATER_VERSION_INSTALLED`.
#### `tag`-based updates
Set the installed version to one of the tags set for a release.
#### `branch`-based updates
Set the installed version to a datetime of one of the latest commits.
A valid version would be: `2020-04-19T22:35:48Z`
### Running artisan commands
Artisan commands can be run before or after the update process and can be configured in `config/self-updater.php`:
**Example:**
```php
'artisan_commands' => [
'pre_update' => [
'updater:prepare' => [
'class' => \App\Console\Commands\PreUpdateTasks::class,
'params' => []
],
],
'post_update' => [
'postupdate:cleanup' => [
'class' => \App\Console\Commands\PostUpdateCleanup::class,
'params' => [
'log' => 1,
'reset' => false,
// etc.
]
]
]
]
```
### Configure the download path
Sometimes your web host does not allow saving files into the `/tmp` folder of the server. You can change the folder the application is downloaded to by setting the
env var `SELF_UPDATER_DOWNLOAD_PATH` to something different. Just keep in mind, that the folder is not inside the folder your application lives in as it might be overwritten
during the update.
### 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 |
### Private repositories
Private repositories can be accessed via (Bearer) tokens. Each repository inside the config file should have
a `private_access_token` field, where you can set the token.
ℹ Do not prefix the token with `Bearer `. This is done automatically.
## Usage
To start an update process, i. e. in a controller, just use:
```php
Route::get('/', function (\Codedge\Updater\UpdaterManager $updater) {
// Check if new version is available
if($updater->source()->isNewVersionAvailable()) {
// Get the current installed version
echo $updater->source()->getVersionInstalled();
// Get the new version available
$versionAvailable = $updater->source()->getVersionAvailable();
// Create a release
$release = $updater->source()->fetch($versionAvailable);
// Run the update process
$updater->source()->update($release);
} else {
echo "No new version available.";
}
});
```
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.
#### Tag-based updates
This is the default. Updates will be fetched by using a tagged commit, aka release.
#### Tag-based updates with assets/package file
If you have pre-packaged _tag based_ releases, you can use the `'repository_types.github.package_file_name'` key in your
`config/self-update.php` file or update the `SELF_UPDATER_PACKAGE_FILE_NAME` `.env` var to specify the asset name to
download.
If you prefix the file name with `regex:` the package will try to find the latest asset matching the given regex. Note
however to use only the regex and not the PHP regex `/` prefix and suffixes. For example, an acceptable value would be
`regex:.releaseV*\.zip`. This will match all assets starting with `releaseV` and ending with `.zip`.
An invalid value would be `regex:/releaseV*\.zip/`. Note the `/` prefix and suffix.
```php
// ...
'repository_types' => [
'github' => [
'type' => 'github',
'repository_vendor' => env('SELF_UPDATER_REPO_VENDOR', ''),
'repository_name' => env('SELF_UPDATER_REPO_NAME', ''),
// ...
'package_file_name' => 'release.zip', // Package file name to download
'package_file_name' => 'regex:releaseV.*\.zip', // REGEX Package file name to download
],
// ...
];
```
#### Branch-based updates
Select the branch that should be used via the `use_branch` setting [inside the configuration](https://github.com/codedge/laravel-selfupdater/blob/master/config/self-update.php).
```php
// ...
'repository_types' => [
'github' => [
'type' => 'github',
'repository_vendor' => env('SELF_UPDATER_REPO_VENDOR', ''),
'repository_name' => env('SELF_UPDATER_REPO_NAME', ''),
// ...
'use_branch' => 'v2',
],
// ...
];
```
### Using Gitlab
Configure Gitlab either via the `config/self-updater.php` or use the appropriate environment variables.
```php
// ...
'repository_types' => [
'gitlab' => [
'base_url' => '',
'type' => 'gitlab',
'repository_id' => env('SELF_UPDATER_REPO_URL', ''),
'download_path' => env('SELF_UPDATER_DOWNLOAD_PATH', '/tmp'),
'private_access_token' => env('SELF_UPDATER_GITLAB_PRIVATE_ACCESS_TOKEN', ''),
],
// ...
];
```
ℹ Although the environment variable is named `SELF_UPDATER_REPO_URL`, only specify your repository id.
For self-hosted Gitlab instances you can set the `base_url` variable to a domain where the instance is hosted at, f. ex. `http://gitlab.acme.local`.
### Using HTTP archives
The package comes with an _HTTP_ source repository type to fetch
releases from an HTTP directory listing containing zip archives.
To run with HTTP archives, use following settings in your `.env` file:
| Config name | Value / Description |
| -------------------------------- | ------------------------------------------ |
| SELF_UPDATER_SOURCE | `http` |
| SELF_UPDATER_REPO_URL | Archive URL, e.g. `http://archive.webapp/` |
| SELF_UPDATER_PKG_FILENAME_FORMAT | Zip package filename format |
| SELF_UPDATER_DOWNLOAD_PATH | Download path on the webapp host server |
The archive URL should contain nothing more than a simple directory listing with corresponding zip-Archives.
`SELF_UPDATER_PKG_FILENAME_FORMAT` contains the filename format for all webapp update packages. I.e. when the update packages listed on the archive URL contain names like `webapp-v1.2.0.zip`, `webapp-v1.3.5.zip`, ... then the format should be `webapp-v_VERSION_`. The `_VERSION_` part is used as semantic versionioning variable for `MAJOR.MINOR.PATCH` versioning. The zip-extension is automatically added.
The target archive files must be zip archives and should contain all files on root level, not within an additional folder named like the archive itself.
### Using Gitea
With _Gitea_ you can use your own Gitea-Instance with tag-releases.
To use it, use the following settings in your `.env` file:
| Config name | Value / Description |
| --------------------------------------- | --------------------------------------- |
| SELF_UPDATER_SOURCE | `gitea` |
| SELF_UPDATER_GITEA_URL | URL of Gitea Server |
| SELF_UPDATER_REPO_VENDOR | Repo Vendor Name |
| SELF_UPDATER_REPO_NAME | Repo Name |
| SELF_UPDATER_GITEA_PRIVATE_ACCESS_TOKEN | Access Token from Gitea |
| SELF_UPDATER_DOWNLOAD_PATH | Download path on the webapp host server |
## Contributing
Please see the [contributing guide](CONTRIBUTING.md).
## Licence
The MIT License (MIT). Please see [Licence file](LICENSE) for more information.