tonyair/silverstripe-externallinks
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-externallinks.git synced 2024-10-22 17:05:44 +02:00
Code Issues Projects Releases Wiki Activity

Merge pull request #100 from creative-commoners/pulls/3.0/cms5-readme

Browse Source 
DOC Update README.md for CMS 5
This commit is contained in:
Sabina Talipova 2023-04-21 14:57:46 +12:00 committed by GitHub
commit 6cc9d5b278
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -11,12 +11,6 @@ The external links module is a task and ModelAdmin to track and to report on bro
* Damian Mooyman (@tractorcow) <damian@silverstripe.com>
## 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
@ -24,10 +18,9 @@ The external links module is a task and ModelAdmin to track and to report on bro
## 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