From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
OOjs UI icon advanced.svg
Release status: experimental
Implementation User interface, Special page
Description Enables archival of external links with the aim of preventing Link Rot.
Author(s) Kevin Browntalk
Latest version 0.1 (2011-08-22)
Database changes Yes
License No license specified
Download Template:WikimediaDownload/svn
  • $wgArchiveLinksConfig
Translate the ArchiveLinks extension if it is available at translatewiki.net
Check usage and version matrix.

The ArchiveLinks extension is designed to fight link rot by preemptively archiving external links so that in the event that they go down a copy will still be available.


  • Download and place the file(s) in a directory called ArchiveLinks in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    require_once "$IP/extensions/ArchiveLinks/ArchiveLinks.php";
  • Run the update script which will automatically create the necessary database tables that this extension needs.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.


All configuration values are put in to a single global variable $wgArchiveLinksConfig as an array. It is important to remember when you are configuring the array not to remove all the values by redefining it by using the array() keyword.

Yes Correct

$wgArchiveLinksConfig['config_value_1'] = true;
$wgArchiveLinksConfig['config_value_2'] = false;

N Incorrect

$wgArchiveLinksConfig = array(
     'config_val_1' => true,
     'config_val_2' => false,

Configuration Options[edit]

The following is a list of the valid configuration options for $wgArchiveLinksConfig.

Config Value Valid Options Description of Value
  • internet_archive
  • wikiwix
  • local
  • webcitation
  • archive.org's archival service
  • wikiwix.com's archival service (archiving new links real time on some wikipedia, and all from the past )
  • if you would like to run a local spider this is the option that should be chosen
  • webcitation.org's archival service
  • true
  • false
If this option is set to true the queue table will be used to generate an archive feed that can be accessed via the API by bots and external services. If you would like to run your own local spider this must be set to false.
Example Example

See Also[edit]