# docs/lychee-external

> Checks every external link over the network.

Checks every external link over the network.

Part of the [`docs`](/reference/configurations/docs/) configuration, at the `recommended` [level](/start/concepts/#levels). It runs only when `gspot check --only docs/lychee-external` names it, per file. It runs lychee. It needs network access.

## Why

External links break over time; this check reports which ones did.

## What to do

Update or remove the link, or exclude the URL pattern with a reason under docs.allowed\_urls.

## Example

A link that returns HTTP 404 reports a broken destination. Replace the URL with a current one, or remove the link.

## Turn it off

Turn it off for some files, or one of its lint rules, with a reason:

```shell
gspot ignore docs/lychee-external --paths "<glob>" --reason "<why>"
gspot ignore docs/lychee-external --rule <rule> --reason "<why>"
```
