Jump to navigation Jump to search

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.
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


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.


Internet Archive

Licensing and cost[edit]

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

Development activity[edit]

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

Platform and interoperability[edit]

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[edit]

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[edit]

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.


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[edit]

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[edit]

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

Influence and take-up[edit]

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.

User Experiences[edit]

Development Activity[edit]

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

Release Feed[edit]

Below the last 3 release feeds:

2022-07-28 08:21:57
[tag:github.com,2008:Repository/2623406/3.4.0-20220727 2022-07-27 Interim Release]
by anjackson
2021-09-30 12:56:11
[tag:github.com,2008:Repository/2623406/3.4.0-20210923 2021-09-23 Interim Release]
by anjackson
2021-08-03 09:44:29
[tag:github.com,2008:Repository/2623406/3.4.0-20210803 2021-08-03 Interim Release]
by anjackson

Activity Feed[edit]

Below the last 5 commits:

2024-02-06 18:21:17
[tag:github.com,2008:Grit::Commit/8549031e59a43d7b4f2763f42d84b589806c9176 Merge pull request #565 from internetarchive/yt-dlp-20230706]
by galgeek https://github.com/galgeek
2023-11-07 22:09:13
[tag:github.com,2008:Grit::Commit/e4c9eb210ad03d592cab67cce0d5e57cd556e3c6 more updates for newer yt-dlp]
by barbara@archive.org
2023-10-11 02:22:17
[tag:github.com,2008:Grit::Commit/d3ca691f8d111d9f9bd1f4ec9eecbbcf02942679 Update CI tests from JDK 20 to 21]
by ato https://github.com/ato
2023-10-11 02:09:53
[tag:github.com,2008:Grit::Commit/bd6c6bbff58832ad8c0fc69ac1dd6d442f69c450 Merge pull request #566 from internetarchive/jdk20]
by ato https://github.com/ato
2023-09-29 22:41:13
[tag:github.com,2008:Grit::Commit/bcfed0c1f7b638a3386f2e48351bcaa802c410a1 yt-dlp (not youtube-dl)]
by barbara@archive.org