2013-08-25 23:49:49 +02:00
# External links
2017-11-23 03:36:00 +01:00
[](https://travis-ci.org/silverstripe/silverstripe-externallinks)
[](https://scrutinizer-ci.com/g/silverstripe/silverstripe-externallinks/?branch=master)
[](https://codecov.io/gh/silverstripe/silverstripe-externallinks)
2014-08-07 06:49:20 +02:00
2013-08-25 23:49:49 +02:00
## Introduction
The external links module is a task and ModelAdmin to track and to report on broken external links.
## Maintainer Contact
2015-11-19 01:28:08 +01:00
* Damian Mooyman (@tractorcow) < damian @ silverstripe . com >
2013-08-25 23:49:49 +02:00
## Requirements
2017-11-23 03:36:00 +01:00
* 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 ).
2013-08-25 23:49:49 +02:00
## Features
* Add external links to broken links reports
* Add a task to track external broken links
## Installation
2017-11-27 05:41:17 +01:00
1. Require the module via composer: `composer require silverstripe/externallinks`
2. Run `/dev/build` in your browser to rebuild the database.
2014-08-13 00:57:41 +02:00
3. Run the following task *http://path.to.silverstripe/dev/tasks/CheckExternalLinks* to check for
broken external links
2013-08-26 04:14:36 +02:00
2014-07-30 02:34:39 +02:00
## Report ##
2014-08-13 00:57:41 +02:00
A new report is added called 'External Broken links report'. When viewing this report, a user may press
the "Create new report" button which will trigger an ajax request to initiate a report run.
In this initial ajax request this module will do one of two things, depending on which modules are included:
* If the queuedjobs module is installed, a new queued job will be initiated. The queuedjobs module will then
manage the progress of the task.
* If the queuedjobs module is absent, then the controller will fallback to running a buildtask in the background.
This is less robust, as a failure or error during this process will abort the run.
In either case, the background task will loop over every page in the system, inspecting all external urls and
checking the status code returned by requesting each one. If a URL returns a response code that is considered
2017-05-12 01:41:14 +02:00
"broken" (defined as < 200 or > 302) then the `ss-broken` css class will be assigned to that url, and
2014-08-13 00:57:41 +02:00
a line item will be added to the report. If a previously broken link has been corrected or fixed, then
this class is removed.
In the actual report generated the user can click on any broken link item to either view the link in their browser,
or edit the containing page in the CMS.
While a report is running the current status of this report will be displayed on the report details page, along
with the status. The user may leave this page and return to it later to view the ongoing status of this report.
Any subsequent report may not be generated until a prior report has completed.
2014-07-30 02:34:39 +02:00
2013-08-26 04:14:36 +02:00
## Dev task ##
Run the following task *http://path.to.silverstripe/dev/tasks/CheckExternalLinks* to check your site for external
broken links.
2014-07-30 02:34:39 +02:00
## Queued job ##
2017-11-23 03:36:00 +01:00
If you have the queuedjobs module installed you can set the task to be run every so often.
2014-07-30 05:29:24 +02:00
## Whitelisting codes ##
If you want to ignore or whitelist certain http codes this can be setup via IgnoreCodes in the config.yml
2017-11-23 03:36:00 +01:00
file in `mysite/_config`
2014-07-30 05:29:24 +02:00
2017-11-23 03:36:00 +01:00
```yml
2017-11-27 05:41:17 +01:00
SilverStripe\ExternalLinks\Tasks\CheckExternalLinksTask:
2014-07-30 05:29:24 +02:00
IgnoreCodes:
- 401
- 403
- 501
2017-11-23 03:36:00 +01:00
```
