taitava/silverstripe-serverrequirementschecker

This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.

A BuildTask for SilverStripe which allows for easy checking that the current server environment still meets the requirements defined by the standard SilverStripe installation process.

2.1.0 2019-10-21 21:23 UTC

This package is auto-updated.

Last update: 2021-09-22 01:25:47 UTC


README

When you install SilverStripe by using the installation wizard, SilverStripe will check that the server environment meets all requirements. For example, certain PHP extensions are ensured to be available and directory writing permissions are checked. This is nice and handy. However, if you move your website/application to a new server or do some other changes to your server environment, SilverStripe by default does not provide any way to recheck the server environment's compatibility. This module simply adds a new BuildTask to your /dev/tasks list that you can use to recheck the requirements anytime. It runs the same tests the SilverStripe installer runs.

Requirements

This module requires SilverStripe 4.x framework. For compatibility with SS3, use the 1.x release line.

Usage

1. Install the module using composer

composer require "taitava/silverstripe-serverrequirementschecker:*"
php vendor/silverstripe/framework/cli-script.php dev/build flush=all

2. Test the environment requirements in browser

For this to work you need to be logged in as an administrator user. Visit the following url: http://website url/dev/tasks/Taitava-ServerRequirementsChecker-ServerRequirementsCheckerTask

3. Alternatively use a terminal for testing

php vendor/silverstripe/framework/cli-script.php /dev/tasks/Taitava-ServerRequirementsChecker-ServerRequirementsCheckerTask

Future plans

  • Create a unit test class which iterates all server environment checks and asserts that they have passed. This would make it easy to integrate environment checks to other testing.

Have your own ideas? Please let me know in the issues! :) Pull requests are also welcome.

Author

Jarkko Linnanvirta jarkko@taitavasti.fi