67 lines
2.4 KiB
Markdown
67 lines
2.4 KiB
Markdown
---
|
|
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](https://www.algolia.com/users/sign_up).
|
|
|
|
2. Choose one of the three methods of signing up: email, GitHub, or Google.
|
|
|
|
3. Fill in your information.
|
|
|
|
|
|
|
|
4. Select the datacenter's region.
|
|
|
|
|
|
|
|
5. Fill in or skip the project information.
|
|
|
|
|
|
|
|
6. Sign up complete! You can go to your dashboard now.
|
|
|
|
|
|
|
|
7. To avoid the trial period ending unexpectedly, you'll want to select a free
|
|
plan. Go to the [Billing](https://www.algolia.com/billing) section.
|
|
|
|
|
|
|
|
8. Choose the _Community_ plan and submit.
|
|
|
|
|
|
|
|
9) You're all good! You can get your API keys now.
|
|
|
|
|
|
|
|
## Get API keys
|
|
|
|
1. [Sign up](#algolia-sign-up) or
|
|
[Sign in](https://www.algolia.com/users/sign_in) to your Algolia account.
|
|
|
|
2. From your **Dashboard**, click on **API Keys**.
|
|
|
|
|
|
|
|
3. Change your keys accordingly (name of Algolia key -> name of our `ENV`
|
|
variable):
|
|
|
|
```text
|
|
Application ID -> ALGOLIASEARCH_APPLICATION_ID
|
|
Search-Only API Key -> ALGOLIASEARCH_SEARCH_ONLY_KEY
|
|
Admin API KEY -> ALGOLIASEARCH_API_KEY
|
|
```
|
|
|
|
|
|
|
|
4. Done.
|