Link Checker Application
 | Displays statuses of external links found in the wiki |
| Type | XAR |
| Category | Application |
| Developed by | |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
| Bundled With | XWiki Standard |
| Compatibility | XWiki 3.3M2+ |
Table of contents
Description
Displays states of external links found in the wiki. The state is displayed as an HTTP Response Code.
Usage
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.
Tips
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()}"
{{/groovy}}
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:
- Log in the wiki with a user having Administration rights
- Go to the Administration page and select the Import category
- Follow the on-screen instructions to upload the downloaded XAR
- Click on the uploaded XAR and follow the instructions
- 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 xwiki.properties file and add the linkchecker transformation. For example:
Dependencies
Dependencies for this extension (org.xwiki.platform:xwiki-platform-linkchecker-ui 14.6):
