Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mapozyan committed Jul 11, 2023
1 parent cc93fa7 commit 7d14c49
Showing 1 changed file with 25 additions and 10 deletions.
35 changes: 25 additions & 10 deletions README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,24 +11,38 @@ key for Power Search dialog is Ctrl+Shift+S.
When you run Power Search, it extracts text from all your books on the fly and sends all text to
the full-text search engine. Plugin will never modify any books and records in Calibre library.
As a search backend, we are using ElasticSearch. Once the index is created and is up-to-date,
Power Search is querying search engine and displaying list of books where certain search keywords
were found. For large libraries, running search for the first time might take a while. Subsequent
searches though will normally take less than a second.
Power Search will be querying search engine and display list of books where certain search keywords
are found. For large libraries, running search for the first time might take a while. Subsequent
searches will normally take less than a second.

Requirements
------------

* ElasticSearch >= 6.x
In order to use Power Search Plugin you need to have ElasticSearch service up and running.
Please follow the instructions provided on the official website to install it:
https://www.elastic.co/guide/en/elasticsearch/reference/current/getting-started-install.html
In order to use Power Search Plugin, you need to have ElasticSearch service up and running.
For local setup, just download ElasticSearch package from the official website
https://www.elastic.co/downloads/elasticsearch and unzip it in any folder.

If your system stays in trusted network (like your home network) and hence you are not much
concerned about fulltext data security, you may simplify configuring ElasticSearch by
disabling security module. Just go to config/elasticsearch.yml and add or modify following
configuration value:

xpack.security.enabled: false


* Pdftotext utility (optional)
Generally, Power Search Plugin is using Calibre's native converters to build full-text index.
However, native PDF conversion is sometimes working too slow. To speed up this process, you
However, native PDF conversion is sometimes working too slowly. To speed up this process, you
can install pdftotext utility and plugin will make use of it. Pdftotext is part of Xpdf and
Poppler projects. Specifically for Debian/Ubuntu check for 'xpdf' or 'libpoppler' apt
packages.
Poppler projects.

Here are some hints:

- Xpdf package can be found here (look for "Xpdf command line tools")
https://www.xpdfreader.com/download.html

- For Debian/Ubuntu, check for 'xpdf' or 'libpoppler' apt packages.

Configuring
-----------
Expand All @@ -42,7 +56,8 @@ Configuring
Example: c:\programs\elasticsearch-7.8.1
If you plan to run ElasticSearch locally, PowerSearch might be set up to launch it in the
background when needed. Just point here to the home directory where ElasticSearch is located.
Note that in this case PowerSearch will manage to stop ElasticSearch when you close Calibre.
Note that in this case PowerSearch will also manage to stop ElasticSearch when you close
Calibre.

* Path to pdftotext tool (optional)
If pdftotext tool can not be found in PATH, enter the full path to pdftotext executable file.
Expand Down

0 comments on commit 7d14c49

Please sign in to comment.