Search by

alveby / atrium-search

xiregroup

Site search for Atrium: one search across every installed module, per site and language, with database full-text on SQLite, MySQL and PostgreSQL

Package info

github.com/AlveBy/atrium-search

Homepage

Issues

Type:atrium-module

pkg:composer/alveby/atrium-search

Statistics

Installs: 0

Dependents: 0

Suggesters: 0

Stars: 0

dev-main / 0.1.x-dev 2026-11-19 05:55 UTC

This package is auto-updated.

Last update: 2026-11-19 23:08:52 UTC


README

Site search for Atrium: one search across every installed module, for the current site and language, with the words marked in the results. The index is a table of the site's own database, with full-text search on MySQL, MariaDB and PostgreSQL and LIKE on SQLite; no outside service.

Install

composer require alveby/atrium-search
php artisan atrium:module:install alveby/atrium-search
php artisan atrium:search:rebuild

What you get

  • /search (route atrium.search) and a search box in the header of the public theme (alveby/atrium-theme): results grouped by module, a page per module, snippets with <mark>.
  • A box in the admin header that finds records of every module the editor may see.
  • GET /api/v1/site-search?q=… for API tokens and the MCP tool search_site.
  • php artisan atrium:search:rebuild to fill the index anew.

Every model with public pages is searched by its name and its text fields; a module or the app says otherwise in extra.atrium.search or config('atrium.search').

The guide: docs/search.md (по-русски).

Hooks

  • atrium.search.sources (filter): the searched models, class => ['title' => …, 'content' => [...]]; add or remove one. See docs/search.md.

Tests

From the repository root:

vendor/bin/phpunit packages/search/tests

The tests cover indexing and the rebuild, languages, sites, dates of publication, the results page, the admin box and the API, on SQLite, MySQL and PostgreSQL.

Contributing

This repository is a read-only copy of packages/search in AlveBy/atrium. Issues and pull requests go there.

License

MIT