tonyair
/
silverstripe-externallinks
mirror of https://github.com/silverstripe/silverstripe-externallinks.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

update readme to reflect v4 upgrade work

This commit is contained in:
Dylan Wagstaff 2017-11-23 15:36:00 +13:00
parent 7bce7dcb2f
commit 77eaa62efc
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,6 +1,8 @@
# External links
[![Build Status](https://travis-ci.org/silverstripe/silverstripe-externallinks.svg?branch=master)](https://travis-ci.org/silverstripe/silverstripe-externallinks)
[![Build Status](http://img.shields.io/travis/silverstripe/silverstripe-externallinks.svg?style=flat)](https://travis-ci.org/silverstripe/silverstripe-externallinks)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/silverstripe/silverstripe-externallinks/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/silverstripe/silverstripe-externallinks/?branch=master)
[![codecov](https://codecov.io/gh/silverstripe/silverstripe-externallinks/branch/master/graph/badge.svg)](https://codecov.io/gh/silverstripe/silverstripe-externallinks)
## Introduction
@ -12,15 +14,15 @@ The external links module is a task and ModelAdmin to track and to report on bro
## Requirements
* SilverStripe 3.1 +
* 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
See the [changelog](CHANGELOG.md) for version history.
## Installation
1. If you have composer you can use `composer require silverstripe/externallinks:*`. Otherwise,
@ -63,20 +65,17 @@ broken links.
## Queued job ##
If you have the queuedjobs module installed you can set the task to be run every so ofter
Add the following yml config to config.yml in mysite/_config have the the task run once every day (86400 seconds)
CheckExternalLinks:
Delay: 86400
If you have the queuedjobs module installed you can set the task to be run every so often.
## Whitelisting codes ##
If you want to ignore or whitelist certain http codes this can be setup via IgnoreCodes in the config.yml
file in mysite/_config
file in `mysite/_config`
```yml
CheckExternalLinks:
Delay: 60
IgnoreCodes:
- 401
- 403
- 501
```