Plugin configuration - Algolia

To set up the Algolia plugin for your Netlify site, you can use the netlify.toml file and environment variables.

Usage

TOML

[[plugins]]
package = "@algolia/netlify-plugin-crawler"
  [plugins.inputs]
  branches = ['main', 'develop', 'feat/add-algolia']
  disabled = true
  pathPrefix = "/blog"
  customDomain = "example.com"
  renderJavaScript = true

Available parameters

`netlify.toml`

The following plugin settings are all optional.

Parameter	Type	Description
`branches`	String array	List of branches the crawler should build. By default, the plugin only builds your main branch, but you can also build other branches. Each branch has its own Algolia index, named `netlify_<site-id>_<branch-name>_all`. Make sure you target the right branch in your frontend. Default is `['master','main']`
`mainBranch`	String	The main project’s branch. If you set this, Algolia copies its index settings to other branches. When the plugin first runs on a new branch, it creates a new index with these settings.
`pathPrefix`	String	Your website’s prefix if it’s not at the root level. For example: `pathPrefix = "/blog" # Will alias "/blog" to "/"`
`customDomain`	String	The custom domain you use, if you can’t set it through Netlify settings. For example: `# Alias "example.com" to "<your-site-url>.netlify.app"` `customDomain = "example.com"`
`renderJavaScript`	Boolean	If `true`, the crawler uses JavaScript to render your website. Useful for single page apps. Default is `false`
`template`	String	Changes how the crawler extracts records and schemas.
`disabled`	Boolean	If `true`, turns off the Netlify plugin but doesn’t remove it. Default is `false`

Environment variables

These environment variables need to be set in your Netlify site settings. The plugin adds them for you.

Variable	Required?	Type	Description
`ALGOLIA_BASE_URL`	Yes	String	URL to target. Should be `https://crawler.algolia.com/`
`ALGOLIA_API_KEY`	Yes	String	API key to verify the call to the crawler
`ALGOLIA_DISABLED`	No	Boolean	If `true`, turns off the Netlify plugin but doesn’t remove it. Default is `false`

Last modified on September 16, 2026