Installation
SearchSync is a WordPress plugin that syncs your content to a search backend and gives you the tools to build search pages on top of it. This page covers installing it and finding your way around.
Requirements
- PHP 8.1 or later
- WordPress 6.4 or later
- One search backend: Algolia, Meilisearch, or the built-in Local backend, which needs no account
note
The plugin's readme lists WordPress 5.9 as the minimum, but the card template editor relies on HTML parsing that arrived in WordPress 6.4.
Install the plugin
- Get the plugin zip file.
- In WordPress, go to Plugins → Add New → Upload Plugin, choose the zip and click Install Now.
- Click Activate.
- Go to Settings → Tangible SearchSync → License and enter your licence key so the plugin can receive updates.
Activating the plugin sets up the tables the Local backend uses, so search works on your own database from the start.
Find your way around
SearchSync adds a SearchSync menu to the WordPress admin:
| Menu item | What it's for |
|---|---|
| Views | The search pages you've built |
| Add New View | Start a new search page |
| Index Settings | Your indexes, their status and reindexing |
| Add New Index | Define a new index |
| Settings | A shortcut to Settings → Tangible SearchSync |
The settings page has three tabs:
- General Settings: the WordPress search override
- Connection Setup: your search backend, staging mode and debug logs
- License: your licence key
All SearchSync screens need the manage_options capability (administrators, by default).
Next steps
- Connect a search backend.
- Create an index and run your first reindex.
- Build your first View.