Toolset to help with the day by day maintenance work.
- dev-master / 2.x-dev
This package is auto-updated.
Last update: 2020-12-21 10:30:30 UTC
The SilverStripe Maintenance module reduces your maintenance related work.
- Requires the
composer.lockfiles to be available and readable in the environment you plan to use this module. All information is based on these files.
- The queuedjobs module updates metadata on your installed modules in the background. You need to configure it to run those jobs.
- For the optional update checkers, the webserver environment needs to be able to contact external information sources through network requests
- Maintenance ^2.2: SilverStripe ^4.4
- Maintenance ~2.1.0: SilverStripe 4.0-4.3
- Maintenance: ^1.0: SilverStripe 3.x
By default, the module will read your installed modules,
and present them as a report in the CMS under
In order to get information about potential updates to these modules, we recommend the installation of two additional modules.
- bringyourownideas/silverstripe-composer-update-checker checks for available updates of dependencies
- bringyourownideas/silverstripe-composer-security-checker checks for known security vulnerabilities
Option 1 (recommended): Install the maintenance package and suggested dependencies
composer require bringyourownideas/silverstripe-maintenance bringyourownideas/silverstripe-composer-security-checker bringyourownideas/silverstripe-composer-update-checker
Option 2 (minimal): Install only the maintenance package without any update checks
composer require bringyourownideas/silverstripe-maintenance
Build schema and queue an initial job to populate the database:
If you haven't already, you need to configure the job queue to update module metadata in the background. By default, this happens every day, but can be configured to run at different intervals through YAML config:
BringYourOwnIdeas\Maintenance\Jobs\CheckForUpdatesJob: reschedule_delay: '+1 hour'
By default, tasks are run through a job queue. You can also choose to manually refresh via the command line.
Run the update task (includes the update-checker)
Run the security update check task (requires the security-checker)
The report available through the CMS shows "Available" and "Latest" versions (see user guide).
The version recommendations in those columns depend on your
composer.json configuration. When setting tight constraints (e.g.
newer releases don't show up as expected. We recommend to have looser constraints by default
silverstripe/framework:^4.3). When the "Latest" version shows
it likely means that you have
"minimum-stability": "dev" in your
Please see the user guide section.
Contributions are welcome! Create an issue, explaining a bug or propose development ideas. Find more information on contributing in the SilverStripe developer documentation.
Please create an issue for any bugs you've found, or features you're missing.