lychee.toml

# Lychee Link Checker Configuration
# https://github.com/lycheeverse/lychee

# Maximum number of concurrent network requests
max_concurrency = 10

# Request timeout in seconds
timeout = 10

# Accept these HTTP status codes as valid
accept = [200, 201, 204, 403, 429, 503]

# Exclude URL patterns (regex)
exclude = [
    # Local development URLs
    'localhost',
    'http://127\.0\.0\.1',
    'https://127\.0\.0\.1',
    'http://0\.0\.0\.0',
    'host\.docker\.internal',

    # Well-known endpoints and example domains
    '\.well-known',
    'api\.node',
    'https://api\.NODE',

    # Self-referential docs URLs (may not exist yet)
    'https://docs\.agntcy\.org/.*',

    # GitHub raw URLs that are generated but may not exist
    'https://github\.com/agntcy/docs/raw/main/docs/.*',

    # Example/placeholder URLs used in documentation
    'example\.com',
    'your-username',
    'company\.com',
    'remote-slim',
    'otel-collector',
    'slim\.slim',
    'schema\.oasf\.agntcy\.org',
    'schema\.oasf\.outshift\.com',
    'api\.agent-identity\.outshift\.com',
    'token\.actions\.githubusercontent\.com',
    'github\.com/example/',
    'spiffe\.github\.io/helm-charts-hardened',

    # Sites that timeout from GitHub Actions IPs
    'w3\.org',
    'gnu\.org',
    'helm\.sh',
    'kind\.sigs\.k8s\.io',

    # GitHub Actions Artifacts (may expire or require login)
    'https://github\.com/agntcy/dir/actions/runs/.*',

    # GitHub pages that redirect or require auth in CI
    'https://github\.com/settings/developers',
    'https://github\.com/login/device',
    'https://github\.com/.*/edit/',

    # MCP Registry (API docs; hash routes or bot blocking in CI)
    'https://registry\.modelcontextprotocol\.io',

    # Sigstore endpoints (may rate-limit or vary in CI)
    'fulcio\.sigstore\.dev',
    'rekor\.sigstore\.dev',

    # Video file path (structure differs in build vs source)
    '.*assets/dir-gui\.mov',
]

# Exclude paths (regex patterns relative to the input)
# Skip MkDocs awesome-pages .index files/dirs that lychee cannot parse
# Skip 404.html: root-relative links need a base URL lychee cannot resolve for local files
exclude_path = ['overrides', '\\.index(/|$)', '(^|/)404\\.html$']

# Enable link caching for faster subsequent runs
cache = true

# Only show errors and summary (not every checked link)
# Set to "info" or "debug" for more verbose output
# Omit or set to false for minimal output

# Maximum number of retries per link (helps with transient HTTP/2 errors to GitHub)
max_retries = 3

# HTTP method to use for checking links
method = "get"

# Exclude links from code blocks, preformatted text, and other verbatim content
include_verbatim = false

# User agent string
user_agent = "lychee/agntcy-docs"