Search system

If you have purchased RKHM before 7/7/2026, please read this article first

RKHM supports two powerful search methods to fit your hosting environment and database size. You can manage these settings by navigating to Admin Panel -> Settings -> General -> Search

Choosing Your Search Engine

In the settings dashboard, you will find the option to select your preferred search provider:

PHP

Best for: Shared hosting, smaller websites, or catalogs with less data

Setup: Works completely out-of-the-box with zero configuration required. It uses your native database capabilities to handle search queries instantly

Meilisearch

Best for: Large-scale platforms running on a VPS or VDS with millions of tracks, albums, or items

Setup: Requires you to have Meilisearch installed and running on your server. It provides lightning-fast, typo-tolerant search results even under very heavy traffic

Configuring Meilisearch

If you choose Meilisearch, you will need to fill in the following configuration fields in your Admin Panel

Meilisearch Endpoint Address: The web address where your Meilisearch instance is running (e.g., [http://127.0.0.1:7700]

Meilisearch Master Key: The private API key required to securely connect RKHM to your Meilisearch instance.

After entering the endpoint address & master key, use existing "Test" button to test RKHM connection to Meilisearch

Once connected, the admin dashboard will display real-time statistics, including the total number of items successfully indexed, database size, and current synchronization status

Meilisearch runs in the background by cronjobs and gradually indexes all of your items

Two Ways to Use Meilisearch: Self-Hosted vs. Cloud API

If you have root access to your server, you can install Meilisearch in few minutes. Alternatively, you can use Meilisearch as cloud api

Option A: Self-Hosted Server: If you prefer absolute control and have a VPS or VDS, you can install the open-source Meilisearch package directly onto your own server.

Option B: Managed Third-Party Cloud API : You can use an official managed provider like Meilisearch Cloud. They handle all the server setup, maintenance, security, and scaling for you. You simply sign up, create an project, and copy your provided Cloud Host URL and API Key directly into RKHM.

Security Tips (For Self-Hosted Users Only)

If you chose to install Meilisearch on your own server instead of using a secure third-party cloud API, keeping it locked down is incredibly important:

Never expose your Meilisearch port to the public internet!

By default, Meilisearch often binds to port 7700. If this port is left open in your server firewall (UFW/iptables), malicious users can access your raw database backend.

Use a Strong Master Key: Never run Meilisearch in development mode without a password in production. Generate a strong, random string for your master key.