crawler

Indexing crawler

This folder is meant to be built into a docker container which will be run as an Algolia connector.

Usage

To run it without docker, first, make sure you've correctly run

bundle install

Then, to run the crawler:

APPLICATION_ID='xxx' \
API_KEY='xxx' \
INDEX_PREFIX='zendesk_' \
CONFIG='{ "app_name": "your-zendesk-subdomain", "email": "[email protected]", "api_token": "xxx" }'
bundle exec ./run

You can generate an API token to your Zendesk instance in the Agent Section > Admin/Settings > API.

Otherwise (and this is what we use when plugging the connector to Algolia), you can use an OAuth token whiche has the hc:read scope.
If you have one, just replace the CONFIG line with

CONFIG='{ "app_name": "your-zendesk-subdomain", "oauth_token": "xxx" }' \

Contributing

We're considering any contribution and PR, please go ahead!

License

This project is under the MIT License.