Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/discourse/discourse-algolia
A plugin for indexing and searching your Discourse with Algolia
https://github.com/discourse/discourse-algolia
algolia discourse-plugin
Last synced: 3 days ago
JSON representation
A plugin for indexing and searching your Discourse with Algolia
- Host: GitHub
- URL: https://github.com/discourse/discourse-algolia
- Owner: discourse
- License: mit
- Created: 2017-09-19T18:46:39.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-11-28T14:49:22.000Z (24 days ago)
- Last Synced: 2024-12-09T14:50:07.620Z (13 days ago)
- Topics: algolia, discourse-plugin
- Language: JavaScript
- Homepage: https://meta.discourse.org/t/add-algolia-search-to-your-discourse/73517
- Size: 715 KB
- Stars: 41
- Watchers: 29
- Forks: 18
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# discourse-algolia [beta]
Official Plugin Topic & Documentation: https://meta.discourse.org/t/add-algolia-search-to-your-discourse/73517
Power the search on your Discourse with [Algolia](https://algolia.com/) 🔎🎉
The discourse-algolia plugin indexes users, posts, topics and tags with Algolia and adds a search box built with [autocomplete.js](https://github.com/algolia/autocomplete.js) to the Discourse header. Try it live on [Algolia's Community Forum](https://discourse.algolia.com/)!
## Features
The discourse-algolia plugin uses the Algolia API, which provides powerful indexing and search capabilities.
- Speed: Results update immediately with each keystroke
- Relevance: Metrics like views and likes are used to surface the best content first
- User experience: All indicies are searched simultaneously and presented in a unified view
- Analytics: See what users are searching for, see top queries that produce 0 results
## Prerequisites
You'll need an Algolia account if you don't have one already.
- Go here to [sign up](https://algolia.com/users/sign_up) for a free account (10,000 records and 100,000 indexing operations monthly)
- If you're using Discourse for an open source project and need higher limits, fill out the form on the [Algolia for Open Source](https://algolia.com/for-open-source) page.
- If you need higher limits for your business, we're happy to help you [find the right plan](mailto:[email protected]).
## Beta testers wanted
Please see this thread on meta.discourse.org for more information: [Add Algolia search to your Discourse](https://meta.discourse.org/t/add-algolia-search-to-your-discourse/73517).
## Installation
Add this repository's `git clone` url to your container's `app.yml` file, at the bottom of the `cmd` section:
```yml
hooks:
after_code:
- exec:
cd: $home/plugins
cmd:
- mkdir -p plugins
- git clone https://github.com/discourse/discourse-algolia.git
```
Rebuild your container:
```
cd /var/discourse
git pull
./launcher rebuild app
```
## Configuration
Once you've installed the plugin and restarted your Discourse, you will see a new plugin available in your admin configuration. Click the `Settings` button next to the `discourse-algolia` plugin.
You will now see all of the plugin configuration options available.
Populate the settings as follows:
- **algolia enabled**: Check this box to enable indexing new content with Algolia.
- **algolia autocomplete enabled**: Check this box to replace the default Discourse autocomplete with the Algolia autocomplete. It is recommended to do this only once you have all content indexed (see below).
- **algolia application id**: The ID of an Algolia application you have created.
- **algolia search api key**: A search-only API key of the Algolia application. Do not use an admin API key, as this will be visible to the clients of your Discourse.
- **algolia admin api key**: The admin API key of your Discourse application, or any API key that can write and configure indices.
You can find the **algolia application id**, **algolia search api key**, and **algolia admin api key** in the **API Keys** page of your [Algolia dashboard](https://algolia.com/dashboard/).
Once all of the settings are turned on and populated, the plugin configuration should look like this:
## Initial indexing
Once you have enabled the Algolia plugin and added an application ID and admin API key, you can now index all of your forum's content. Run the following rake task in your Discourse directory:
```shell
LOAD_PLUGINS=1 bundle exec rails algolia:reindex
```
This will create and configure three indices - `discourse-users`, `discourse-posts`, and `discourse-tags` - and then populate them by loading data from your database and sending it to Algolia. The data will be searchable as soon as the task is finished. You can now enable the **algolia autocomplete enabled** setting of the plugin, reload the page of your Discourse, and try the autocomplete search.
## Rake tasks
To run rake tasks, first `cd` into your Discourse directory. If you're using the Docker install, just run this command:
```shell
./launcher enter app
```
Additional rake tasks are provided for configuring indices and syncing data.
```
rake algolia:reindex # reindex everything to algolia
rake algolia:reindex_posts # reindex posts in algolia
rake algolia:reindex_tags # reindex tags in algolia
rake algolia:reindex_users # reindex users in algolia
```
## Styling with CSS
To see how you can change the look and feel of the autocomplete, see the CSS styles in the plugin's [assets/stylesheets](https://github.com/algolia/discourse-algolia/tree/main/assets/stylesheets) directory.
```
.algolia-holder .aa-input {
color: #919191;
font-family: Open Sans, Arial, sans-serif;
border: solid 1px rgba(137,149,199,0.2);
border-radius: 6px;
font-size: 13px;
line-height: 13px;
padding: 8px 10px 8px 35px;
height: auto;
width: 250px;
outline: 0;
background-image: url("data:image/svg+xml;utf8,");
background-size: 14px 14px;
background-repeat: no-repeat;
background-position: 10px center;
}
```
You'll see style definitions like this, which you can override by creating a fork of the plugin or more easily by using the CSS/HTML customization that Discourse makes available in the Admin tool.
## Customizing ranking
Once you've indexed your data with Algolia, you can see it and search it from the Algolia dashboard. That will give you an idea of what attributes the plugin indexes. You can also make changes to relevance and other index configuration settings. A full treatment of ranking, relevance and the Algolia dashboard is out of scope here, but we encourage you to head over to the [Algolia documentation](https://algolia.com/doc/) and start digging in.
