silverstripe-externallinks/README.md
2013-08-26 09:50:20 +12:00

35 lines
1.0 KiB
Markdown

# External links
## Introduction
The external links module is a task and ModelAdmin to track and to report on broken external links.
## Maintainer Contact
* Kirk Mayo kirk (at) silverstripe (dot) com
## Requirements
* SilverStripe 3.0 +
## Features
* Add external links to broken links reports
* Add a model admin for external broken links
* Add a task to track external broken links
## Installation
1. Download the module form GitHub (Composer support to be added)
2. Extract the file (if you are on windows try 7-zip for extracting tar.gz files
3. Make sure the folder after being extracted is named 'externallinks'
4. Place this directory in your sites root directory. This is the one with framework and cms in it.
5. Run in your browser - `/dev/build` to rebuild the database.
6. You should see a new menu called *Broken Ext. Links*
## Disable the Broken external link menu
To disable the *Broken Ext. Links* menu add the following code to mysite/_config.php
`CMSMenu::remove_menu_item('BrokenExternalLinksAdmin');`