Link Checker Application

Last modified by Admin on 2024/06/20 00:53

link_breakDisplays statuses of external links found in the wiki
Developed by

XWiki Development Team

0 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Standard


XWiki 3.3M2+

Installable with the Extension Manager


This application depends on the Link Checker API.

Displays states of external links found in the wiki. The state is displayed as an HTTP Response Code.


Navigate to the XWiki.ExternalLinks page an you'll see a list of all external links found in your wiki as shown below. Note that the links are discovered only when someone navigates on a page containing external links.


If you have the Index Application installed then you'll also see new tab for External Links appearing on the Main.AllDocs page:


Security Implications

Note that this application has some security implications since it allows everyone having access to the AllDocs page to see all external links available anywhere in the wiki, even links that are on page for which they don't have access to. To mitigate this risk, it's possible to change the Page Rights for the XWiki.ExternalLinks document.


If you wish to check the Link Checker indexation queue size you could use the following in a page (you'll need Programming Rights):

import com.xpn.xwiki.web.*
import org.xwiki.rendering.transformation.*

def checker = Utils.getComponent(Transformation.class, "linkchecker")

print "Link checker queue size = ${checker.linkQueue.size()}"

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

The Link Checker isn't enabled by default. To enable it, edit your file and add the linkchecker transformation. For example:

rendering.transformations = macro, icon, linkchecker

If you activate the Link Checker feature you need to be aware that in a multiwiki setup any user in a subwiki will be able to see all link statuses of all subwikis. Since this could be a privacy issue you need to be sure you're ok with this. We're planning to find a solution for this in the near future.


Dependencies for this extension (org.xwiki.platform:xwiki-platform-linkchecker-ui 16.4.0):

Get Connected