0ct0pu5/orcinus-search
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Automatically crawl your website and add search-engine capability.
181 commits 1 branch 0 tags 4.2 MiB
PHP 93.7%
JavaScript 6%
CSS 0.2%
Find a file
Brian Huisman 2b80228f2a Update PHP version check for 8.1.x
2024-05-27 11:52:40 -04:00
orcinus Update PHP version check for 8.1.x 2024-05-27 11:52:40 -04:00
.gitattributes Initial commit 2023-04-11 22:02:16 -04:00
.gitignore Add PDF Last Modified multiplier 2023-09-08 15:11:27 -04:00
example.html Update Bootstrap and jQuery 2023-09-28 11:37:46 -04:00
example.php Update Bootstrap and jQuery 2023-09-28 11:37:46 -04:00
LICENSE Initial commit 2023-04-11 22:02:16 -04:00
README.md Update README.md 2024-05-17 12:10:28 -04:00

README.md

Orcinus Site Search

By Brian Huisman

ℹ️ NOTE: The Orcinus project is now in "release candidate" status. Please use it on your websites and send any feedback my way, or submit issue reports here on Github. Thanks so much for your interest!

orcinus-banner

The Orcinus Site Search PHP script is an all-in-one website crawler, indexer and search engine that extracts searchable content via HTTP/HTTPS from plain text, XML, HTML and PDF files at a single, or multiple websites. It replaces 3rd party, remote search solutions such as Google etc.

Orcinus will crawl your website content on a schedule, or at your command via the admin UI or even by CLI / crontab. Crawler log output conveniently informs you of missing pages, broken links or links that redirect, and other errors that a webmaster can fix to keep the user experience tight. A full-featured, Bootstrap-based responsive administration GUI allows you to adjust crawl settings, view and edit all crawled pages, customize search results, and view a log of user search queries. You also have complete control over the appearance of your search results with a convenient templating system.

Optionally, Orcinus can generate a sitemap .xml or .xml.gz file of your pages after every crawl, suitable for uploading to the Google Search Console. It can also export a JavaScript version of the entire search engine that works with offline mirrors, such as those generated by HTTrack.

Requirements:

  • PHP >= 8.1.x
  • MySQL >= 8.0.17 / MariaDB >= 10.0.5

3rd Party Libraries:

Included:

Optional:

Getting Started

  1. Copy the orcinus directory to your root web directory.
  2. Fill out your SQL and desired credential details in the orcinus/config.ini.php file.
  3. Visit yourdomain.com/orcinus/admin.php in your favourite web browser and log in.
  4. Optionally follow the instructions in orcinus/geoip2/README.md to enable geolocation of search queries.

Examples of search interface integration are given in the example.php (online / PHP) and example.html (offline / JavaScript) files.