From a16b6e4aad88f0c3bafb0cc267741ab28103f860 Mon Sep 17 00:00:00 2001 From: EParzefall Date: Thu, 21 Oct 2021 15:51:06 +0200 Subject: [PATCH 1/5] added content for v2 of the search_elastic app --- .../pages/configuration/search/index.adoc | 19 +++++++++++-------- .../pages/files/webgui/search.adoc | 9 ++++++++- 2 files changed, 19 insertions(+), 9 deletions(-) diff --git a/modules/admin_manual/pages/configuration/search/index.adoc b/modules/admin_manual/pages/configuration/search/index.adoc index e35b752333..0a9fb16a5d 100644 --- a/modules/admin_manual/pages/configuration/search/index.adoc +++ b/modules/admin_manual/pages/configuration/search/index.adoc @@ -1,18 +1,20 @@ = Full Text Search :toc: right -:ingest-attachment-processor-url: https://www.elastic.co/guide/en/elasticsearch/plugins/5.6/ingest-attachment.html +:elastic-search-url: https://www.elastic.co/elasticsearch/ :search_elastic-app-url: {oc-marketplace-url}/apps/search_elastic - +:simple-query-string-query-url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html == Introduction The {search_elastic-app-url}[Full Text Search app] integrates full text search into ownCloud, powered by Elasticsearch. == Prerequisites -A fully functioning Elasticsearch server with the {ingest-attachment-processor-url}[ingest-attachment processor] must be present. -The ingest-attachment processor lets Elasticsearch extract file attachments in common formats, such as PPT, XLS, and PDF. +A fully functioning {elastic-search-url}[Elasticsearch server] with the ingest-attachment processor must be present. + +NOTE: Version 1.0.0 of the Full Text Search app only works with Elasticsearch version 5.6. With version 2.0.0 of the app, Elasticsearch version 7 is supported. -To install the processor, from your Elasticsearch installation directory, run the following command: +The ingest-attachment processor lets Elasticsearch extract file attachments in common formats. +To install the processor, run the following command from your Elasticsearch installation directory: [source=console] ---- @@ -20,9 +22,6 @@ bin/elasticsearch-plugin install ingest-attachment service elasticsearch restart ---- -NOTE: Only Elasticsearch version 5.6 is fully supported by version 1.0.0 of the Full Text Search app. -Version 7 of Elasticsearch will be supported by version 2.0.0 of the app. - == Install and Configure the Full Text Search App To install the app, use the Marketplace app on your ownCloud server or proceed manually: @@ -38,6 +37,10 @@ image:apps/search_elastic/configuration_successful.png[Configuring Elasticsearch TIP: The index can also be managed from the command line, via the xref:configuration/server/occ_command.adoc#full-text-search[occ search:index commands]. These commands let administrators _create_, _rebuild_, _reset_, and _update_ the search index. +With version 2.0.0 of the app, simple query string queries can be used. For more information, see the {simple-query-string-query-url}[Simple query string query documentation]. + +To find out more about usage, check out the section in the User Manual: xref:user_manual:/files/webgui/search.adoc[Search & Full Text Search]. + == Known Limitations Currently, the app has the following known limitations: diff --git a/modules/user_manual/pages/files/webgui/search.adoc b/modules/user_manual/pages/files/webgui/search.adoc index 0e9a423d07..e888702aa0 100644 --- a/modules/user_manual/pages/files/webgui/search.adoc +++ b/modules/user_manual/pages/files/webgui/search.adoc @@ -1,5 +1,6 @@ = Search & Full Text Search :toc: right +:elastic-query-url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html == Introduction @@ -17,4 +18,10 @@ The search is not case-sensitive, so capital letters are treated the same as low Things get tricky when you don't remember what the file you're looking for was called and guess work doesn't help. A key word search within text documents is only possible if the Full Text Search app is installed. Contact your admin if you need it and it's not installed. With this app enabled, you can search in files of the most common formats. -Version 1.0.0 of the Full Text Search app works like the regular search. You start typing and the search starts even on incomplete words. +Version 1.0.0 of the Full Text Search app works like the regular search. You start typing and the search starts even on incomplete words or partials. + +With version 2 of the Full Text Search app, this behavior changes. You can no longer simply enter "pain" and expect to see all results containing this string. Instead you need to add an asterisk * to search for all instances starting with "pain": pain*. In the highly unlikely case you actually do want to get results for pain and Spain, add an asterisk as prefix *pain. To get results for pain, Spain and painful, use *pain*. + +The asterisk works as a wildcard. Any string of characters can preceed or follow the characters you enter. More complex searches are now possible to help you define more precisely what to look for. Check out the instructions on how to use the {elastic-query-url}[simple query string query] by Elasticsearch for more complex search options. + +NOTE: While the regular search is not case sensitive, the Full Text Search app is. A search for "spain" won't display hits for "Spain". From 2e2730431cc9f3050f9f16b9e2520aebdfb2c396 Mon Sep 17 00:00:00 2001 From: EParzefall Date: Thu, 21 Oct 2021 16:04:32 +0200 Subject: [PATCH 2/5] fixed asterisk markup --- modules/user_manual/pages/files/webgui/search.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/user_manual/pages/files/webgui/search.adoc b/modules/user_manual/pages/files/webgui/search.adoc index e888702aa0..aa8923ce4c 100644 --- a/modules/user_manual/pages/files/webgui/search.adoc +++ b/modules/user_manual/pages/files/webgui/search.adoc @@ -20,7 +20,7 @@ Things get tricky when you don't remember what the file you're looking for was c Version 1.0.0 of the Full Text Search app works like the regular search. You start typing and the search starts even on incomplete words or partials. -With version 2 of the Full Text Search app, this behavior changes. You can no longer simply enter "pain" and expect to see all results containing this string. Instead you need to add an asterisk * to search for all instances starting with "pain": pain*. In the highly unlikely case you actually do want to get results for pain and Spain, add an asterisk as prefix *pain. To get results for pain, Spain and painful, use *pain*. +With version 2 of the Full Text Search app, this behavior changes. You can no longer simply enter "pain" and expect to see all results containing this string. Instead you need to add an asterisk * to search for all instances starting with "pain": pain*. In the highly unlikely case you actually do want to get results for pain and Spain, add an asterisk as prefix: \*pain. To get results for pain, Spain and painful, use \*pain*. The asterisk works as a wildcard. Any string of characters can preceed or follow the characters you enter. More complex searches are now possible to help you define more precisely what to look for. Check out the instructions on how to use the {elastic-query-url}[simple query string query] by Elasticsearch for more complex search options. From c9f573f2a766fba9bbc06abbea6eae8ff725815e Mon Sep 17 00:00:00 2001 From: Edith Parzefall Date: Mon, 25 Oct 2021 09:57:50 +0200 Subject: [PATCH 3/5] Update modules/admin_manual/pages/configuration/search/index.adoc --- modules/admin_manual/pages/configuration/search/index.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/admin_manual/pages/configuration/search/index.adoc b/modules/admin_manual/pages/configuration/search/index.adoc index 0a9fb16a5d..3e8fbf0e8d 100644 --- a/modules/admin_manual/pages/configuration/search/index.adoc +++ b/modules/admin_manual/pages/configuration/search/index.adoc @@ -11,7 +11,7 @@ The {search_elastic-app-url}[Full Text Search app] integrates full text search i A fully functioning {elastic-search-url}[Elasticsearch server] with the ingest-attachment processor must be present. -NOTE: Version 1.0.0 of the Full Text Search app only works with Elasticsearch version 5.6. With version 2.0.0 of the app, Elasticsearch version 7 is supported. +NOTE: Version 1.0.0 of the Full Text Search app only works with Elasticsearch version 5.6. With version 2.0.0 of the app, Elasticsearch version 7 is supported and required. The ingest-attachment processor lets Elasticsearch extract file attachments in common formats. To install the processor, run the following command from your Elasticsearch installation directory: From 99d148c113e93b1cbfe5b8359be889b9f39d2f25 Mon Sep 17 00:00:00 2001 From: EParzefall Date: Tue, 2 Nov 2021 15:14:48 +0100 Subject: [PATCH 4/5] removed all mention of simple query sting queries --- .../admin_manual/pages/configuration/search/index.adoc | 7 ++----- modules/user_manual/pages/files/webgui/search.adoc | 10 +--------- 2 files changed, 3 insertions(+), 14 deletions(-) diff --git a/modules/admin_manual/pages/configuration/search/index.adoc b/modules/admin_manual/pages/configuration/search/index.adoc index 3e8fbf0e8d..9182c95716 100644 --- a/modules/admin_manual/pages/configuration/search/index.adoc +++ b/modules/admin_manual/pages/configuration/search/index.adoc @@ -5,7 +5,7 @@ :simple-query-string-query-url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html == Introduction -The {search_elastic-app-url}[Full Text Search app] integrates full text search into ownCloud, powered by Elasticsearch. +The {search_elastic-app-url}[Full Text Search app] integrates full text search into ownCloud, powered by Elasticsearch. This allows users to search not only for file names but also within files stored in ownCloud. == Prerequisites @@ -34,11 +34,9 @@ To configure the Full Text Search, go to menu:Settings[Search (admin)] and set t .Configuring Elasticsearch in ownCloud image:apps/search_elastic/configuration_successful.png[Configuring Elasticsearch in ownCloud] -TIP: The index can also be managed from the command line, via the xref:configuration/server/occ_command.adoc#full-text-search[occ search:index commands]. +TIP: The index can also be managed from the command line, via the xref:configuration/server/occ_commands/core_commands/full_text_search_commands.adoc[occ search:index commands]. These commands let administrators _create_, _rebuild_, _reset_, and _update_ the search index. -With version 2.0.0 of the app, simple query string queries can be used. For more information, see the {simple-query-string-query-url}[Simple query string query documentation]. - To find out more about usage, check out the section in the User Manual: xref:user_manual:/files/webgui/search.adoc[Search & Full Text Search]. == Known Limitations @@ -47,7 +45,6 @@ Currently, the app has the following known limitations: * Files are shown twice in search results when searching by filename. * If a shared file is renamed by the sharee (share receiver), the sharee cannot find the file using the new filename. -* If the search query doesn't match the _start_ of at least one word in an available file's name, no results are returned. * Search results are not updated when a text file is rolled back to an earlier version. * The app does not return results for federated share files. * The app only works with the default encryption module "_Master Key_". diff --git a/modules/user_manual/pages/files/webgui/search.adoc b/modules/user_manual/pages/files/webgui/search.adoc index aa8923ce4c..20a1750d78 100644 --- a/modules/user_manual/pages/files/webgui/search.adoc +++ b/modules/user_manual/pages/files/webgui/search.adoc @@ -1,6 +1,5 @@ = Search & Full Text Search :toc: right -:elastic-query-url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html == Introduction @@ -16,12 +15,5 @@ The search is not case-sensitive, so capital letters are treated the same as low == Full Text Search App -Things get tricky when you don't remember what the file you're looking for was called and guess work doesn't help. A key word search within text documents is only possible if the Full Text Search app is installed. Contact your admin if you need it and it's not installed. With this app enabled, you can search in files of the most common formats. +Things get tricky when you don't remember what the file you're looking for was called and guess work doesn't help. A key word search within text documents is only possible if the Full Text Search app is installed. Contact your admin if you need it and it's not installed. With this app enabled, you can search in files of the most common formats. Like with the regular search, you can enter partial strings. -Version 1.0.0 of the Full Text Search app works like the regular search. You start typing and the search starts even on incomplete words or partials. - -With version 2 of the Full Text Search app, this behavior changes. You can no longer simply enter "pain" and expect to see all results containing this string. Instead you need to add an asterisk * to search for all instances starting with "pain": pain*. In the highly unlikely case you actually do want to get results for pain and Spain, add an asterisk as prefix: \*pain. To get results for pain, Spain and painful, use \*pain*. - -The asterisk works as a wildcard. Any string of characters can preceed or follow the characters you enter. More complex searches are now possible to help you define more precisely what to look for. Check out the instructions on how to use the {elastic-query-url}[simple query string query] by Elasticsearch for more complex search options. - -NOTE: While the regular search is not case sensitive, the Full Text Search app is. A search for "spain" won't display hits for "Spain". From 4b908a2b5afd7a2344f8123fb711fe7b7bec4f92 Mon Sep 17 00:00:00 2001 From: EParzefall Date: Sat, 4 Dec 2021 15:57:20 +0100 Subject: [PATCH 5/5] [10.9] [PR 4155] Content for search elastic v2 Backport of PR #4155 --- modules/user_manual/pages/files/webgui/search.adoc | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/modules/user_manual/pages/files/webgui/search.adoc b/modules/user_manual/pages/files/webgui/search.adoc index 20a1750d78..d569c2499c 100644 --- a/modules/user_manual/pages/files/webgui/search.adoc +++ b/modules/user_manual/pages/files/webgui/search.adoc @@ -7,7 +7,7 @@ ownCloud comes with a regular search function allowing you to find files by thei == Regular Search -The regular search function in the ownCloud web interface offers a simple search for elements of file names. This also works when you only enter "pain" but meant to look for spain. However, you may also get results for pain or painful. If you start at the top level "All files", you will also see results in subfolders. If you change into a directory, the search starts in this folder, displays the results, then continues to search in all other folders. +The regular search function in the ownCloud web interface offers a simple search for elements of file names. This also works when you only enter "pain" but meant to look for Spain. However, you also get results for pain or painful. If you start at the top level "All files", you will also see results in subfolders. If you change into a directory, the search starts in this folder, displays the results, then continues to search in all other folders. A click on one of the results takes you either to the location of the file, if you are not already in that folder, or the item is opened. @@ -15,5 +15,7 @@ The search is not case-sensitive, so capital letters are treated the same as low == Full Text Search App -Things get tricky when you don't remember what the file you're looking for was called and guess work doesn't help. A key word search within text documents is only possible if the Full Text Search app is installed. Contact your admin if you need it and it's not installed. With this app enabled, you can search in files of the most common formats. Like with the regular search, you can enter partial strings. +Things get tricky when you don't remember what the file you're looking for was called and guess work doesn't help. A key word search within text documents is only possible if the Full Text Search app is installed. Contact your admin if you need it and it's not installed. With this app enabled, you can search within files of the most common formats. Like with the regular search, you can enter only the first part of a string and it matches all occurances of words starting with the search string. + +If you are looking for all terms containing a specific string like in the above example "pain", wildcards can be used, e.g. an asterisk: *pain gives you results like braine, Spain and painful. Using a question mark instead of the asterisk limits the preceeding characters to exactly one. In this example, only Spain would show up if you entered the search string "?pain".