Heritrix

Heritrix is an open-source web crawler, allowing users to target websites they wish to include in a collection and to harvest an instance of each site.
Homepage:	https://github.com/internetarchive/heritrix3/wiki
License:	GNU Lesser General Public License 2.1
Platforms:	Written in Java. Must have Java Runtime Environment (JRE, http://www.java.com/en/download/index.jsp) and at least Java version 5.0 installed. Default heap size is 256MB RAM.
Wikidata ID:	Q3097891
Function:	Web Capture
Content type:	Web
Appears in COW:	Quality Assurance: Iterative Seed Issue Decision Tree, Web Archiving Quality Assurance (QA) Workflow, Web Archiving Quality Assurance Lifecycle

Mailing List(s)

See here for more information.

Issues Feed

Failed to load RSS feed from https://webarchive.jira.com/sr/jira.issueviews:searchrequest-rss/temp/SearchRequest.xml?jqlQuery=project+%3D+HER&tempMax=100: There was a problem during the HTTP request: 400 Bad Request

Description

Heritrix is an open-source web crawler, allowing users to target websites they wish to include in a collection and to harvest an instance of each site. The software is most often used as a powerful back-end tool incorporated into a web archiving workflow.

Provider

Internet Archive

Licensing and cost

Apache License, Version 2.0 – free. Some individual source code files are subject to or offered under other licenses.

Development activity

Version 3.1.1 was released in May 2012. Heritrix powers the Internet Archive, and so receives ongoing support.

Platform and interoperability

As a Java application, Heritrix is theoretically platform agnostic; however, only Linux is supported.  The software requires Java Runtime Environment 1.6 or higher, and at least 256MB of available RAM.

Functional notes

Web crawls are carried out by configuring a ‘job,’ which itself is an instance of a crawl template called a ‘profile.’ Although they contain the same configurations, these two entities have different functions; profiles record the set of configurations and act as a starting point for shaping a new job, but only the job itself can excecute a crawl. The software will crawl FTP sites in addition to HTTP. Users can examine the results of a crawl by opening its log files, which include information about crawl problems and errors, each URI that was collected, and statistics about the job as a whole. Users can also create reports showing a summary of the crawl’s activity. Heritrix stores the web resources it crawls in an Arc file. The software includes a command-line tool called arcreader which can be used to extract the contents.

Documentation and user support

The User Guide for versions 3.0 and 3.1 is in the form of a wiki, which at time of writing is not structured in any obvious narrative order; while detailed, it is very difficult to navigate.  The User Manual for version 2.0 is structured and can be used as a reference for navigation.  Extensive documentation is available, including release notes, Javadoc API documentation, and FAQs linking within the wiki. Heritrix’s website links to two active mailing lists: a yahoo discussion group and a sourceforge list distributing source code commits. The project also uses a public JIRA for bug, feature, and issue tracking.

Usability

Heritrix is installed via a command line interface, but once installed the user can launch a web-based interface for configuration. Setting up a crawl requires a significant number of adjustments.

Expertise required

Installation requires solid knowledge of Linux and command line interfaces. As with any web archiving software, deep understanding of the project’s scope and collections policy is essential in order to set up appropriate targets.

Standards compliance

Heritrix does not offer metadata support. The software is designed to respect robots.txt exclusion directives and META robots tags.

Influence and take-up

Heritrix is extremely influential; as of March 2012, the SourceForge site reports nearly 240,000 downloads. Users include the Internet Archive, the British Library, the United States Library of Congress, and the French National Library. The software powers NetarchiveSuite and the Web Curator Tool.

Development Activity

All development activity is visible on GitHub: http://github.com/internetarchive/heritrix3/commits

Release Feed

Below the last 3 release feeds:

2025-05-13 04:49:16

[tag:github.com,2008:Repository/2623406/3.9.0 3.9.0]

by ato

2025-04-01 12:28:58

[tag:github.com,2008:Repository/2623406/3.8.0 3.8.0]

by ato

2025-02-03 05:26:03

[tag:github.com,2008:Repository/2623406/3.7.0 3.7.0]

by ato

Activity Feed

Below the last 5 commits:

2025-05-13 05:23:08

[tag:github.com,2008:Grit::Commit/51347f769820397032806c48565679890a6bef2e docs: Use javalang17 fork]

by ato https://github.com/ato

2025-05-13 05:19:35

[tag:github.com,2008:Grit::Commit/7db91b53c679124acbbf364889956b20433b3ce5 docs: HTTP/2: correct code quotes instead of italics]

by ato https://github.com/ato

2025-05-13 05:16:36

[tag:github.com,2008:Grit::Commit/e1ac68f533ca9544e078a569c4ec9fa12d6c4733 docs: Correct bean-example path for FetchHTTP2]

by ato https://github.com/ato

2025-05-13 05:15:20

[tag:github.com,2008:Grit::Commit/fee534c3dbdb9cb0a1a1c9fc94df4cf33d845afb docs: Get version from pom.xml]

by ato https://github.com/ato

2025-05-13 05:09:09

[tag:github.com,2008:Grit::Commit/81ac46be4557e07bbb346223fe957f22e220ad11 docs: Catch parse errors and continue generating]

by ato https://github.com/ato