manifest / integrations / opensearch-connect

OpenSearch Connect

Developer plugin to connect your WP Instance with OpenSearch.

by Storm Rockwell · github.com/stormrockwell/opensearch-connect · website

★ 1stars

Install

Download source zip No release zip yet

This is the repository archive. It installs, but the folder name will carry the branch suffix and updates will not flow.

Install straight from GitHub with WP-CLI:

wp plugin install https://github.com/stormrockwell/opensearch-connect/archive/refs/heads/main.zip

No built-in updater. New versions won't appear under Dashboard → Updates. Install new releases yourself, or let Git Updater track the repository.

Readme github.com/stormrockwell/opensearch-connect ↗

THIS IS A WORK IN PROGRESS. NOT COMPLETED

OpenSearch Connect

Plugin designed to connect your WordPress instance with OpenSearch.

TODO

Zero downtime reindexer using a index manager
Search
Admin interface - Hosts, indexables,
Maybe using an action scheduler if large syncs hurt the site.

Prerequisites

Docker
Composer
Nodejs
PHP - Optional to power PHP Code Sniffer for VSCode

Included DevTools & Tests

XDebug
PHPUnit
PHPCS & PHPCBF

If you are using VSCode, I'd suggest installing the following extensions to fully take advantage of the tools.

PHP Debug
PHP Sniffer & Beautifier
Run on Save

Setup

npm i && composer install
docker-compose build wp (only need to do this once)
docker-compose up -d

You can now access the WordPress instance at https://localhost:8080, OpenSearch at https://localhost:9200 and OpenSearch dashboards at http://localhost:5601

Using Test Suite

Install scripts for PHPUnit docker-compose exec wp install-wp-tests

docker-compose exec wp cr test # runs PHPUnit and PHPCS
docker-compose exec wp cr phpunit
docker-compose exec wp cr phpcs
docker-compose exec wp cr fix # Runs PHPCBF