Software

Installation for EE 3+

1. Unzip the folder to a temporary location on your local hard drive.
2. FTP the files from their local folders to the same locations in your EE install’s /system/user/addons/ folder on the server.
3. Navigate to Add-ons in your EE control panel and install the add-on. That’s it!

Installation for EE 2

1. Unzip the folder to a temporary location on your local hard drive.
2. FTP the files from their local folders to the same locations in your EE install’s /system/expressionengine/third_party/ folder on the server.
3. Navigate to Modules in your EE control panel and install the add-on. That’s it!

Installation for EE 1

1. Unzip the folder to a temporary location on your local hard drive.
2. FTP the files from their local folders to the same locations in your EE install’s /system/ folder on the server.
3. Navigate to Modules tab in your EE control panel and install the add-on. That’s it!

Usage

Hop 404 Reporter requires just one tag placed into your 404 page template in order to track and report all errors:

{exp:hop_404_reporter:process_url}

You can access Hop 404 Reporter’s settings by going to Add-Ons/Modules, selecting the module, and then clicking Settings. In Settings, you can control whether Hop 404 Reporter is running, whether notifications are being sent, turn referrer tracking on/off, and control the sender, subject line, and content of notification emails.

Referrer URLs

You may review the log of 404 errors by going to Add-Ons/Modules and selecting the module.

In the URL list the URL, Referral URL, Count, and Date of last occurrence. The referrer URL can have 3 different values.

• A URL: The user arrived at the 404 URL from this referrer URL. If you go to this page, you may find the incorrect link.
• Referrer not specified: This means there is no referrer. In most of the cases, this occurs when the user entered a URL manually.
• Referrer not tracked: If you disabled the referrer tracking in the settings, this will be displayed.

Email Notifications

Hop 404 Reporter allows you to set up multiple email notifications. Here’s how:

1. Go to Add-Ons/Modules and select the module. This opens the settings.
2. Select Email notifications.
3. Select Add new email notification.
4. Fill in the Email Address that should receive the notifications.
5. Choose a URL filter: This field is parsed as a regular expression so you can create advanced filters. But it’s also very easy to use. If you want a notification when a 404 URL contains “wrong_url”, just enter “wrong_url” in this field. It’s as simple as that. If you leave it empty, the notification will be sent each time a 404 occurs, whatever the URL is.
6. Toggle Notification Referrer Required: By default, you will only get an alert when the request includes a referrer url. You can switch this off if you want to receive all 404 page alerts.
7. Choose your Notification Interval: You can choose to get an alert only when it first occurs, or each time it happens. If a 404 occurs with a different referrer, it will be reported as a new error.

Reset an email notification: This is useful for notifications where the interval is set to “once.” The reset will erase all previous notifications that have been delivered, resetting the notifications as though they were just created.

Track Unused Templates

Enable Track Unused Templates in the settings for a few weeks (or use the Crawl Pages to go through all the public links on your website) and review the unused templates. Any templates not accessed for weeks or months are probably orphaned pages and can be cleaned up. Each template will only get tracked once.

IMPORTANT Some templates may not be marked actively in use by the crawler because they are hidden pages like /admin.

Crawl Pages

Hop 404 Reporter comes with a link discovery crawler that will go through your site and recursively find public links to go to until there are no more new links. It will only visit any URLs once and document an example referrer URL for you to study how people can access/find those pages.

URLs to convert to Your templates or entries could contain HTTP/HTTPS or www/non-www URL inconsistencies. Use this field to specify which URLs need to be converted to the correct format.

Full URLs of starting pages to crawl If there are any pages that people cannot link to, specify them e.g. /search/results or /gated_content.

When you start crawling, Hop 404 Reporter will start from the base_url and stage any links it can find. Once it’s done, it will go through the staged URLs and continue to stage more new links. The page needs to be open for the crawling to continue. If you click away, you can Resume Crawling.

Updating

Updating is easy:

1. Download a new version from this website, and extract on your hard drive.
2. Upload the new files to their appropriate locations.