feat(search): added experimental setup support for OpenSearch

thorsten · thorsten · commit 5c2d113ee061 · 2025-05-16T07:38:22.000+02:00
diff --git a/docs/administration.md b/docs/administration.md
@@ -450,10 +450,18 @@ You can click through the update wizard:
 ### 5.6.5 Elasticsearch configuration
 
 Here you can create and drop the Elasticsearch index, and you can run a full import of all data from your database
-into the Elasticsearch index. You can also see some Elasticsearch relevant usage data. This page is only available if
-Elasticsearch is enabled.
+into the Elasticsearch index. 
+You can also see some Elasticsearch relevant usage data. 
+This page is only available if Elasticsearch is enabled.
 
-### 5.6.6 System information
+### 5.6.6 OpenSearch configuration
+
+Here you can create and drop the OpenSearch index, and you can run a full import of all data from your database
+into the OpenSearch index.
+You can also see some OpenSearch relevant usage data.
+This page is only available if OpenSearch is enabled.
+
+### 5.6.7 System information
 
 On this page, phpMyFAQ displays some relevant system information like PHP version, database version or session path.
 Please use this information when reporting bugs.
diff --git a/docs/index.md b/docs/index.md
@@ -3,7 +3,7 @@
 phpMyFAQ is a comprehensive, multilingual FAQ system that is entirely database-driven.
 It is compatible with a variety of databases for data storage and requires PHP 8.2+ for data access.
 The system features a multi-language Content Management System equipped with a WYSIWYG editor and an Image Manager.
-It also provides real-time search capabilities with Elasticsearch.
+It also provides real-time search capabilities with Elasticsearch or OpenSearch.
 
 phpMyFAQ supports flexible multi-user functionality,
 offering user and group-based permissions on categories and records.
diff --git a/docs/installation.md b/docs/installation.md
@@ -185,10 +185,10 @@ of SQLite.
 If PHP was compiled with the LDAP extension, you can add your LDAP or Microsoft Active Directory information, too.
 Then you can insert your LDAP or Microsoft Active Directory information as well.
 
-### Step 3: Elasticsearch support
+### Step 3: Elasticsearch and OpenSearch support
 
-If you want to use Elasticsearch, you can activate this in the third step. You have to add at least one Elasticsearch
-node and the index name.
+If you want to use Elasticsearch or OpenSearch, you can activate this in the third step.
+You have to add at least one Elasticsearch or OpenSearch node and the index name.
 
 ### Step 4: Admin user setup
 
@@ -231,7 +231,7 @@ You can change
   The term you are looking for should also not be in more than 50% of all your entries, or it will automatically be
   excluded from search. This is not a bug, but rather a feature of MySQL.
 - The search on other databases is using the LIKE operator currently.
-- To improve the search functionality, you should consider using Elasticsearch.
+- To improve the search functionality, you should consider using Elasticsearch or OpenSearch.
 
 ## 2.9 Automatic user language detection
 
@@ -353,7 +353,17 @@ If you choose to add this during installation, the file will be automatically wr
 If you enabled Elasticsearch support in the admin configuration panel, you can create, re-import and delete your
 index with a user-friendly interface.
 
-## 2.17 SSO (Single Sign-On) Support
+## 2.17 OpenSearch Support
+
+To improve the search performance and quality of search results, it's possible to use OpenSearch.
+You need a running OpenSearch instance accessible by phpMyFAQ via HTTP/REST.
+You can add the IP(s)/Domain(s) and port(s) of your OpenSearch cluster during installation or later by renaming the
+OpenSearch file located in the folder config/.
+If you choose to add this during installation, the file will be automatically written and the index will be built.
+If you enabled OpenSearch support in the admin configuration panel, you can create, re-import and delete your
+index with a user-friendly interface.
+
+## 2.18 SSO (Single Sign-On) Support
 
 phpMyFAQ supports SSO (Single Sign-On)
 with the REMOTE_USER server variable is populated by the web server or application server
diff --git a/docs/thank-you.md b/docs/thank-you.md
@@ -4,6 +4,6 @@ Thank you for using phpMyFAQ! :-)
 
 Authors: Thorsten Rinne, Stephan Hochhaus, Markus Gläser, Jan Harms
 
-© 2001-2024 phpMyFAQ Team
+© 2001-2025 phpMyFAQ Team
 
 This documentation is licensed under a [Creative Commons License](http://creativecommons.org/licenses/by/2.0/).
diff --git a/phpmyfaq/assets/src/configuration/setup.ts b/phpmyfaq/assets/src/configuration/setup.ts
@@ -24,7 +24,7 @@ export const selectDatabaseSetup = (event: Event): void => {
 
   const target = event.target as HTMLSelectElement;
 
-  if (target.value === 'sqlite3') {
+  if (target.value === 'sqlite3' || target.value === 'pdo_sqlite') {
     for (let i: number = 0; i < inputs.length; i++) {
       inputs[i].removeAttribute('required');
     }
@@ -38,21 +38,25 @@ export const selectDatabaseSetup = (event: Event): void => {
 
   switch (target.value) {
     case 'mysqli':
+    case 'pdo_mysql':
       databasePort.value = '3306';
       sqlite.className = 'd-none';
       database.className = 'd-block';
       break;
     case 'pgsql':
+    case 'pdo_pgsql':
       databasePort.value = '5432';
       sqlite.className = 'd-none';
       database.className = 'd-block';
       break;
     case 'sqlsrv':
+    case 'pdo_sqlsrv':
       databasePort.value = '1433';
       sqlite.className = 'd-none';
       database.className = 'd-block';
       break;
     case 'sqlite3':
+    case 'pdo_sqlite':
       sqlite.className = 'd-block';
       database.className = 'd-none';
       break;
diff --git a/phpmyfaq/assets/templates/setup/index.twig b/phpmyfaq/assets/templates/setup/index.twig
@@ -196,15 +196,28 @@
             </div>
 
             <div class="step">
-              <h3 class="mb-3"> Step 3/4: Elasticsearch setup</h3>
+              <h3 class="mb-3"> Step 3/4: Elasticsearch / OpenSearch setup</h3>
               {% if isElasticsearchEnabled %}
-                <div class="form-group">
-                  <div class="form-check">
-                    <input id="elasticsearch_enabled" class="form-check-input" type="checkbox"
-                           name="elasticsearch_enabled" value="yes">
-                    <label class="form-check-label" for="elasticsearch_enabled">
-                      Enable Elasticsearch support?
-                    </label>
+                <div class="row mb-2">
+                  <div class="form-group">
+                    <div class="form-check">
+                      <input id="elasticsearch_enabled" class="form-check-input" type="checkbox"
+                             name="elasticsearch_enabled" value="yes">
+                      <label class="form-check-label" for="elasticsearch_enabled">
+                        Enable Elasticsearch support?
+                      </label>
+                    </div>
+                  </div>
+                </div>
+                <div class="row mb-2">
+                  <div class="form-group">
+                    <div class="form-check">
+                      <input id="opensearch_enabled" class="form-check-input" type="checkbox"
+                             name="opensearch_enabled" value="yes">
+                      <label class="form-check-label" for="opensearch_enabled">
+                        Enable OpenSearch support?
+                      </label>
+                    </div>
                   </div>
                 </div>
                 <div class="row mb-2">
@@ -214,11 +227,12 @@
                       <input type="text" name="elasticsearch_server[]" id="elasticsearch_server"
                              class="form-control" placeholder="127.0.0.1:9200">
                       <span class="input-group-text" id="pmf-add-elasticsearch-host" style="cursor: pointer;">
-                        Add another Elasticsearch Host
+                        Add another host
                       </span>
                     </div>
                     <small class="form-text text-muted">
-                      Please enter the host (domain or IP) with port number of your Elasticsearch server.
+                      Please enter the host (domain or IP) with port number of your Elasticsearch/OpenSearch server.
+                      The format for OpenSearch is <code>https://<em>domain</em>:<em>port</em></code>.
                     </small>
                   </div>
                 </div>
diff --git a/phpmyfaq/src/phpMyFAQ/Instance/Setup.php b/phpmyfaq/src/phpMyFAQ/Instance/Setup.php
@@ -168,4 +168,21 @@ public function createElasticsearchFile(array $data, string $folder = '/content/
             LOCK_EX
         );
     }
+
+    /**
+     * Creates the file /content/core/config/opensearch.php
+     *
+     * @param  int[]|string[] $data   Array with OpenSearch credentials
+     * @param  string         $folder Folder
+     */
+    public function createOpenSearchFile(array $data, string $folder = '/content/core/config'): int|bool
+    {
+        return file_put_contents(
+            $this->rootDir . $folder . '/config/opensearch.php',
+            '<?php
+$PMF_OS[\'hosts\'] = [\'' . implode("'], ['", $data['hosts']) . "'];\n" .
+            "\$PMF_OS['index'] = '" . $data['index'] . "';\n",
+            LOCK_EX
+        );
+    }
 }
diff --git a/phpmyfaq/src/phpMyFAQ/Setup/Installer.php b/phpmyfaq/src/phpMyFAQ/Setup/Installer.php
@@ -20,9 +20,11 @@
 use Composer\Autoload\ClassLoader;
 use Elastic\Elasticsearch\ClientBuilder;
 use Elastic\Elasticsearch\Exception\AuthenticationException;
+use OpenSearch\SymfonyClientFactory;
 use phpMyFAQ\Configuration;
 use phpMyFAQ\Configuration\DatabaseConfiguration;
 use phpMyFAQ\Configuration\ElasticsearchConfiguration;
+use phpMyFAQ\Configuration\OpenSearchConfiguration;
 use phpMyFAQ\Core\Exception;
 use phpMyFAQ\Database;
 use phpMyFAQ\Database\DatabaseDriver;
@@ -36,6 +38,7 @@
 use phpMyFAQ\Instance\Database\Stopwords;
 use phpMyFAQ\Instance\Elasticsearch;
 use phpMyFAQ\Instance\Main;
+use phpMyFAQ\Instance\OpenSearch;
 use phpMyFAQ\Instance\Setup;
 use phpMyFAQ\Ldap;
 use phpMyFAQ\Link;
@@ -729,6 +732,7 @@ public function checkInitialRewriteBasePath(Request $request): bool
      *
      * @param array|null $setup
      * @throws Exception|AuthenticationException
+     * @throws \Exception
      */
     public function startInstall(array|null $setup = null): void
     {
@@ -907,7 +911,7 @@ public function startInstall(array|null $setup = null): void
             $classLoader->addPsr4('React\\Promise\\', PMF_SRC_DIR . '/libs/react/promise/src');
             $classLoader->register();
 
-            // check LDAP connection
+            // check Elasticsearch connection
             $esHosts = array_values($esHosts['elasticsearch_server']);
             $esClient = ClientBuilder::create()->setHosts($esHosts)->build();
 
@@ -918,6 +922,48 @@ public function startInstall(array|null $setup = null): void
             $esSetup = [];
         }
 
+        //
+        // Check OpenSearch if enabled
+        //
+        $openSearchEnabled = Filter::filterInput(INPUT_POST, 'opensearch_enabled', FILTER_SANITIZE_SPECIAL_CHARS);
+        if (!is_null($openSearchEnabled)) {
+            $osSetup = [];
+            $osHostFilter = [
+                'opensearch_server' => [
+                    'filter' => FILTER_SANITIZE_SPECIAL_CHARS,
+                    'flags' => FILTER_REQUIRE_ARRAY
+                ]
+            ];
+
+            // OS hosts
+            $osHosts = Filter::filterInputArray(INPUT_POST, $osHostFilter);
+            if (is_null($osHosts)) {
+                throw new Exception('OpenSearch Installation Error: Please add at least one OpenSearch host.');
+            }
+
+            $osSetup['hosts'] = $osHosts['opensearch_server'];
+
+            // OS Index name
+            $osSetup['index'] = Filter::filterInput(INPUT_POST, 'opensearch_index', FILTER_SANITIZE_SPECIAL_CHARS);
+            if (is_null($osSetup['index'])) {
+                throw new Exception('OpenSearch Installation Error: Please add an OpenSearch index name.');
+            }
+
+            // check OpenSearch connection
+            $osHosts = array_values($osHosts['opensearch_server']);
+            $osClient = (new SymfonyClientFactory())->create([
+                'base_uri' => $osHosts[0],
+                'verify_peer' => false,
+            ]);
+
+            if (!$osClient) {
+                throw new Exception('OpenSearch Installation Error: No connection to OpenSearch.');
+            }
+        } else {
+            $osSetup = [];
+        }
+
+
         // check the login name
         if (!isset($setup['loginname'])) {
             $loginName = Filter::filterInput(INPUT_POST, 'loginname', FILTER_SANITIZE_SPECIAL_CHARS);
@@ -999,6 +1045,14 @@ public function startInstall(array|null $setup = null): void
             );
         }
 
+        // check if OpenSearch is enabled
+        if (!is_null($openSearchEnabled) && count($osSetup) && !$instanceSetup->createOpenSearchFile($osSetup, '')) {
+            self::cleanFailedInstallationFiles();
+            throw new Exception(
+                'OpenSearch Installation Error: Setup cannot write to ./content/core/config/opensearch.php.'
+            );
+        }
+
         // connect to the database using config/database.php
         $databaseConfiguration = new DatabaseConfiguration($rootDir . '/content/core/config/database.php');
         try {
@@ -1134,6 +1188,23 @@ public function startInstall(array|null $setup = null): void
             $esInstance->createIndex();
         }
 
+        // connect to OpenSearch if enabled
+        if (!is_null($openSearchEnabled) && is_file($rootDir . '/config/opensearch.php')) {
+            $osConfiguration = new OpenSearchConfiguration($rootDir . '/config/opensearch.php');
+
+            $configuration->setOpenSearchConfig($osConfiguration);
+
+            $osClient = (new SymfonyClientFactory())->create([
+                'base_uri' => $osConfiguration->getHosts()[0],
+                'verify_peer' => false,
+            ]);
+
+            $configuration->setOpenSearch($osClient);
+
+            $osInstance = new OpenSearch($configuration);
+            $osInstance->createIndex();
+        }
+
         // adjust RewriteBase in .htaccess
         $configurator = new EnvironmentConfigurator($configuration);
         $configurator->adjustRewriteBaseHtaccess();
