https://github.com/jonasraoni/fulltextsearch
Provides a database-backed full-text index for OJS/OMP/OPS, compatible with MySQL and PostgreSQL.
https://github.com/jonasraoni/fulltextsearch
Last synced: 4 months ago
JSON representation
Provides a database-backed full-text index for OJS/OMP/OPS, compatible with MySQL and PostgreSQL.
- Host: GitHub
- URL: https://github.com/jonasraoni/fulltextsearch
- Owner: jonasraoni
- License: gpl-3.0
- Created: 2025-08-22T17:37:28.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-09-01T14:49:59.000Z (4 months ago)
- Last Synced: 2025-09-01T16:33:57.555Z (4 months ago)
- Language: PHP
- Size: 330 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/pkp/ojs/tree/stable-3_3_0)
[](https://github.com/pkp/omp/tree/stable-3_3_0)
[](https://github.com/pkp/ops/tree/stable-3_3_0)
# Full Text Search Plugin
## About
Provides a replacement for the default search engine that comes with OJS/OMP/OPS, which performs very poorly on large datasets, it's backed by full-text index and it's compatible with MySQL and PostgreSQL.
**Key Features:**
- **Comprehensive Indexing**: Indexes submission titles, abstracts, authors, keywords, subjects, disciplines, and full-text content
- **Advanced Search**: Full-text search with relevance scoring and ranking
- **Multi-Context Support**: Search across all journals/presses/servers or limit to specific contexts
- **Performance Optimized**: Database-backed search index for fast query execution
- **Flexible Configuration**: Customizable search settings and index rebuilding options
- **Cleanup Tools**: Automatic removal of unpublished content from search results
## Installation Instructions
We recommend installing this plugin using the Plugin Gallery within OJS/OPS/OMP. Log in with administrator privileges, navigate to `Settings` > `Website` > `Plugins`, and choose the Plugin Gallery. Find the `Full Text Search Plugin` there and install it.
> If for some reason, you need to install it manually:
> - Download the latest release (attention to the OJS/OPS/OMP version compatibility) or from GitHub (attention to grab the code from the right branch).
> - Create the folder `plugins/generic/fullTextSearch` and place the plugin files in it.
> - Run the command `php lib/pkp/tools/installPluginVersion.php plugins/generic/fullTextSearch/version.xml` at the main OJS/OPS/OMP folder, this will ensure the plugin is installed/upgraded properly.
**After installing and enabling the plugin, access its settings and rebuild the search index for all contexts**
**After re-indexing and ensuring the plugin is working fine, access the settings again, and make sure you mark the checkbox to clear the standard search tables. Besides making the database much smaller (if your installation is large, there will be millions of records on them), it will improve the upgrade speed.**
## Configuration
The plugin provides several configuration options:
- **Index Rebuilding**: Rebuild the search index for selected contexts to ensure data freshness
- **Standard Search Cleanup**: Option to clear existing search tables when rebuilding the index
## Technical Details
- **Database Table**: Creates a dedicated `full_text_search_plugin_index` table
- **Search Engine**: Uses database-specific full-text search capabilities (MySQL MATCH/AGAINST, PostgreSQL tsvector/tsquery)
- **Indexing**: Automatically indexes published submissions and their associated files
- **Performance**: Optimized queries with relevance scoring and pagination support
## Notes
- This is a site-wide plugin, which means its settings are shared across all the journals/presses/servers of the installation.
- The plugin automatically handles indexing of new submissions and updates to existing content.
- Search results are ranked by relevance score for better user experience.
## Contact/Support
If you have issues, please use the issue tracker (https://github.com/jonasraoni/fullTextSearch/issues).