Files
rancher-docs/dev-resources/algolia-search

Algolia with Rancher Documentation

The search index used by the Rancher documentation is generated by running our own crawler.

Running the Crawler

To run the crawler, you'll need:

  • A configuration file, which can be found here.
  • An .env file, containing your credentials.
APPLICATION_ID=<app_id>
API_KEY=<key_with_write_permissions>

If you're running the crawler from the Docker image, run:

docker run -it --env-file=.env -e "CONFIG=$(cat ./config.json | jq -r tostring)" algolia/docsearch-scraper

Otherwise, follow these instructions if running the crawler using the code base.