@linkrivers-webops/netlify-plugin

Netlify Build Plugin that automatically installs LinkRivers SEO scanner functions on every build.

Installation

Add to your netlify.toml:

[[plugins]]
package = "@linkrivers-webops/netlify-plugin"

[plugins.inputs]
siteKey = "LR-XXXXXXXX"

Or install locally:

npm install @linkrivers-webops/netlify-plugin

Configuration

| Input | Required | Default | Description | |-------|----------|---------|-------------| | siteKey | Yes | - | Your LinkRivers site key | | apiKey | No | "" | LinkRivers API key for reporting results | | functions | No | "seo-scan,broken-links,security-headers,health" | Comma-separated list of functions to install |

Example with all options:

[[plugins]]
package = "@linkrivers-webops/netlify-plugin"

[plugins.inputs]
siteKey = "LR-XXXXXXXX"
apiKey = "your-api-key"
functions = "seo-scan,health"

What Gets Installed

The plugin installs these serverless functions:

| Function | Endpoint | Description | |----------|----------|-------------| | lr-health | /.netlify/functions/lr-health | Health check endpoint | | lr-seo-scan | /.netlify/functions/lr-seo-scan | Full SEO analysis | | lr-broken-links | /.netlify/functions/lr-broken-links | Check for broken links | | lr-security-headers | /.netlify/functions/lr-security-headers | Security headers audit |

Environment Variables

You can also configure via environment variables:

| Variable | Description | |----------|-------------| | LINKRIVERS_SITE_KEY | Your site key (overrides plugin input) | | LINKRIVERS_API_KEY | Your API key (overrides plugin input) | | LINKRIVERS_API_URL | API URL (default: https://api.linkrivers.com) |

How It Works

1. During onPreBuild, the plugin creates the function files
2. Functions are placed in netlify/functions/ directory
3. Shared library code is placed in lib/linkrivers/
4. On successful build, functions are deployed automatically

Testing

After deployment, test the health endpoint:

curl https://your-site.netlify.app/.netlify/functions/lr-health

Expected response:

{
  "status": "ok",
  "service": "linkrivers-seo-scanner",
  "timestamp": "2024-01-15T10:30:00.000Z"
}

Support

• Documentation: https://linkrivers.com/docs/netlify-plugin
• Issues: https://github.com/linkrivers/netlify-plugin-linkrivers/issues

License

MIT