diff --git a/admin_manual/configuration/configuring_search.rst b/admin_manual/configuration/configuring_search.rst new file mode 100644 index 000000000..82c58a0c4 --- /dev/null +++ b/admin_manual/configuration/configuring_search.rst @@ -0,0 +1,32 @@ +Enabling Full-Text Search +========================= +The Full-Text Search app indexes plain text, ``.docx``, ``.xlsx``, ``.pptx``, +``.odt``, ``.ods`` and ``.pdf`` files stored in ownCloud. It is based on Zend +Search Lucene, which is a good general purpose text +search engine written in PHP 5. The Zend Lucene index is stored on the +filesystem (in ``owncloud/data/$user/lucene_index``) and does not require a database server. + +Using the Full-Text Search app is literally set-it-and-forget-it: all you do is +enable it on your Apps page, and then it automatically indexes all documents on +your ownCloud server. It does not index files on remote storage services or +devices. + +.. figure:: ../images/lucene-search-enable.png + +When you want to find a document, enter your search term in the search field at +the upper right of your ownCloud Web interface. You can run a search from any +ownCloud page. Hover your cursor over any of your search results to see what +folder it is in, or click on the filename and it takes you to the folder. + + +.. figure:: ../images/lucene-search-user.png + +**Known limitations** + +It does not work with the Encryption app, because the background indexing +process does not have access to the key needed to decrypt files when the user is +not logged in. + +Not all PDF versions can be indexed because its text extraction may be +incompatible with newer PDF versions. + diff --git a/admin_manual/configuration/index.rst b/admin_manual/configuration/index.rst index 7069b4498..cf747b54f 100644 --- a/admin_manual/configuration/index.rst +++ b/admin_manual/configuration/index.rst @@ -30,3 +30,4 @@ Configuration custom_mount_config custom_user_backend xsendfile + configuring_search diff --git a/admin_manual/images/lucene-search-enable.png b/admin_manual/images/lucene-search-enable.png new file mode 100644 index 000000000..2e4c2b61e Binary files /dev/null and b/admin_manual/images/lucene-search-enable.png differ diff --git a/admin_manual/images/lucene-search-user.png b/admin_manual/images/lucene-search-user.png new file mode 100644 index 000000000..d16322c06 Binary files /dev/null and b/admin_manual/images/lucene-search-user.png differ diff --git a/admin_manual/index.rst b/admin_manual/index.rst index e3273a706..addec0a64 100644 --- a/admin_manual/index.rst +++ b/admin_manual/index.rst @@ -75,6 +75,7 @@ contains the following topics: * :doc:`configuration/configuration_language` * :doc:`configuration/configuration-antivirus` * :doc:`configuration/configuration_preview` +* :doc:`configuration/configuring_search` Maintenance ===========