maverick/docbrown
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
docbrown/docs/backend/algolia.md
Jacob Herrington 2d3a974803
Include instructions to set Algolia plan (#5941)
2020-02-06 17:21:05 -06:00

2.4 KiB
Raw Blame History

title
Algolia

Algolia for Search

Algolia is a third party service that powers the search. When working with the API, you will likely need to utilize Algolia. You will need to sign up for a free-tier account, retrieve the keys, and provide those keys to the Rails application.

Sign up

  1. Go to the Algolia sign up page.

  2. Choose one of the three methods of signing up: email, GitHub, or Google.

  3. Fill in your information.

    algolia-up-1

  4. Select the datacenter's region.

    algolia-up-2

  5. Fill in or skip the project information.

    algolia-up-3

  6. Sign up complete! You can go to your dashboard now.

    algolia-up-4

  7. To avoid the trial period ending unexpectedly, you'll want to select a free plan. Go to the Billing section.

    algolia-community-plan-1

  8. Choose the Community plan and submit.

    algolia-community-plan-2

  1. You're all good! You can get your API keys now.

    algolia-up-5

Get API keys

  1. Sign up or Sign in to your Algolia account.

  2. From your Dashboard, click on API Keys.

    algolia-1

  3. Change your keys accordingly (name of Algolia key -> name of our ENV variable):

    Application ID -> ALGOLIASEARCH_APPLICATION_ID
Search-Only API Key -> ALGOLIASEARCH_SEARCH_ONLY_KEY
Admin API KEY -> ALGOLIASEARCH_API_KEY

    algolia-2

  4. Done.