Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
Synopsis
The Web Page Archive module allows you to use Drupal to perform periodic snapshots and visual regression testing on local and remote websites based of a list of URLs or XML sitemaps, all within the familiar Drupal admin interface.
Watch Texas Camp 2018 - Archiving and Visual Regression using Drupal 8 for a basic walkthrough of functionality and a demonstration.
Capture Utilities (Archiving)
Snapshots are performed by Capture Utility plugins. Web Page Archive provides the following capture utilities:
| Plugin | Machine Name | Purpose |
|---|---|---|
| HTML Capture Utility | wpa_html_capture | Captures raw HTML from URLs. |
| Screenshot Capture Utility | wpa_screenshot_capture | Capture Screenshots of URLs (uses Headless Chrome or PhantomJS). |
| Skeleton Capture Utility | wpa_skeleton_capture | Example code that provides a template for building additional capture utility plugins. |
Comparison Utilities (Visual Regression)
Comparisons are performed by Comparison Utility plugins. Web Page Archive provides the following capture utilities:
| Plugin | Machine Name | Purpose | Applies to |
|---|---|---|---|
| File: Size | web_page_archive_file_size_compare | Compares files based on size | Screenshots, HTML |
| HTML: Diff | wpa_html_diff_compare | Compares HTML line-by-line | HTML |
| Screenshot: Pixel | wpa_screenshot_capture_pixel_compare | Compares images and generates diff images (uses ImageMagick 7.0+) | Screenshots |
| Screenshot: Slider | wpa_screenshot_capture_slider_compare | Compares images via slider | Screenshots |
Other modules extending Web Page Archive:
- Accessibility Scanner - Scans websites for web accessibility issues.
- Performance Budget - Creates and manages performance budgets for websites.
Requirements
- Drupal 8.3.x+ (managed with composer)
- PHP 7.1+
- PHP extensions: ext-openssl, ext-mbstring
- Each capture or comparison utility may have additional requirements. See their respective installation guides for more information.
- A lot of storage space (especially when using screenshot capture utility)
Installation
See the following guides for installing web page archive dependencies:
- Getting Started with Web Page Archive
- Installing Headless Chrome
- Installing PhantomJS
- Installing ImageMagick
- Comparing HTML and Screenshots
- Uninstalling Web Page Archive
Roadmap
Help wanted!
This is a relatively new module and features are continuously being added. If you would like to assist in the development of this module, we welcome your help.
Please follow the Drupal Coding Standards.
Ways you can help:
- Use the Module and Let Us Know Your Thoughts
- Report Bugs
- Submit Ideas/Patches on drupal.org
- Submit Pull Requests on github.com
- Write Tests
- Write/Edit Documentation
Helpful Links:
Project Maintainers:
- David Stinemetze (@WidgetsBurritos)
- David Porter (@bighappyface)
- Paul Maddern (@pobster)
- Adrianna Flores (@vessel_adrift)
Supporting organizations:
Provided development resources
Project information
Seeking new maintainer
The current maintainers are looking for new people to take ownership.
No further development
No longer developed by its maintainers.- Module categories: Developer Tools
17 sites report using this module- Created by pobster on , updated
Stable releases for this project are covered by the security advisory policy.
There are currently no supported stable releases.
