forked from kmayo-ss/externallinks
-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #100 from creative-commoners/pulls/3.0/cms5-readme
DOC Update README.md for CMS 5
- Loading branch information
Showing
1 changed file
with
3 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,23 +11,16 @@ The external links module is a task and ModelAdmin to track and to report on bro | |
|
||
* Damian Mooyman (@tractorcow) <[email protected]> | ||
|
||
## Requirements | ||
|
||
* Silverstripe ^4.0 | ||
|
||
**Note:** For a Silverstripe 3.x compatible version, please use [the 1.x release line](https://github.com/silverstripe/silverstripe-externallinks/tree/1.0). | ||
|
||
## Features | ||
|
||
* Add external links to broken links reports | ||
* Add a task to track external broken links | ||
|
||
## Installation | ||
|
||
1. Require the module via composer: `composer require silverstripe/externallinks` | ||
2. Run `/dev/build` in your browser to rebuild the database. | ||
3. Run the following task *http://path.to.silverstripe/dev/tasks/CheckExternalLinks* to check for | ||
broken external links | ||
```sh | ||
composer require silverstripe/externallinks | ||
``` | ||
|
||
## Report | ||
|
||
|
@@ -77,13 +70,6 @@ SilverStripe\ExternalLinks\Tasks\CheckExternalLinksTask: | |
- 501 | ||
``` | ||
## Upgrading from 1.x to 2.x | ||
When upgrading from 1.x to 2.x (Silverstripe 3.x to 4.x) you will need to be aware of the following API changes: | ||
* Configuration property `CheckExternalLinksTask.IgnoreCodes` renamed to `CheckExternalLinksTask.ignore_codes` | ||
* Configuration property `CheckExternalLinksTask.FollowLocation` and `BypassCache` renamed to `follow_location` and `bypass_cache` | ||
|
||
## Follow 301 redirects | ||
You may want to follow a redirected URL a example of this would be redirecting from http to https | ||
|