TheAnachronism/docspell
1
0
Fork 0
mirror of https://github.com/TheAnachronism/docspell.git synced 2025-06-22 02:18:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix documentation about fulltext search

Browse Source
This commit is contained in:
eikek
2022-04-24 18:34:22 +02:00
parent f5958b3a51
commit 9851b71c45
5 changed files with 26 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
modules/joex/src/main/resources/reference.conf
View File

@ -699,13 +699,13 @@ Docpell Update Check
} }
} }
# Configuration of the full-text search engine. # Configuration of the full-text search engine. (the same must be used for restserver)
full-text-search { full-text-search {
# The full-text search feature can be disabled. It requires an # The full-text search feature can be disabled. It requires an
# additional index server which needs additional memory and disk # additional index server which needs additional memory and disk
# space. It can be enabled later any time. # space. It can be enabled later any time.
# #
# Currently the SOLR search platform is supported. # Currently the SOLR search platform and PostgreSQL is supported.
enabled = false enabled = false
# Which backend to use, either solr or postgresql # Which backend to use, either solr or postgresql

4
modules/restserver/src/main/resources/reference.conf
View File

@ -289,13 +289,13 @@ docspell.server {
secret = "" secret = ""
} }
# Configuration of the full-text search engine. # Configuration of the full-text search engine. (the same must be used for joex)
full-text-search { full-text-search {
# The full-text search feature can be disabled. It requires an # The full-text search feature can be disabled. It requires an
# additional index server which needs additional memory and disk # additional index server which needs additional memory and disk
# space. It can be enabled later any time. # space. It can be enabled later any time.
# #
# Currently the SOLR search platform is supported. # Currently the SOLR search platform and PostgreSQL is supported.
enabled = false enabled = false
# Which backend to use, either solr or postgresql # Which backend to use, either solr or postgresql

9
website/site/content/docs/configure/fulltext-search.md
View File

@ -29,6 +29,9 @@ full-text-search {
All docspell components must provide the same fulltext search All docspell components must provide the same fulltext search
configuration. configuration.
The features provided for full text search depends on the backend.
Docspell only hands the query to the backend and thus content queries
may not work across different fulltext search backends.
## SOLR ## SOLR
@ -46,8 +49,8 @@ subsection:
} }
``` ```
The default configuration at the end of this page contains more The [default configuration](@/docs/configure/main.md#default-config)
information about each setting. contains more information about each setting.
The `solr.url` is the mandatory setting that you need to change to The `solr.url` is the mandatory setting that you need to change to
point to your SOLR instance. Then you need to set the `enabled` flag point to your SOLR instance. Then you need to set the `enabled` flag
@ -60,7 +63,7 @@ That will provide you with the connection url (the last part is the
core name). If Docspell detects an empty core it will run a schema core name). If Docspell detects an empty core it will run a schema
setup on start automatically. setup on start automatically.
The `full-text-search.solr` options are the same for joex and the The `full-text-search.solr` options must be the same for joex and the
restserver. restserver.
Sometimes it is necessary to re-create the entire index, for example Sometimes it is necessary to re-create the entire index, for example

2
website/site/content/docs/install/download_run.md
View File

@ -1,5 +1,5 @@
+++ +++
title = "Download & Run" title = "Manual Installation"
weight = 22 weight = 22
+++ +++

20
website/site/content/docs/install/prereq.md
View File

@ -69,9 +69,9 @@ sudo apt-get install ghostscript tesseract-ocr tesseract-ocr-deu tesseract-ocr-e
# Apache SOLR # Apache SOLR
SOLR is used to provide the fulltext search feature. This feature can SOLR is a very powerful fulltext search engine and can be used to
be disabled, so installing SOLR is optional. But without it, there is provide the fulltext search feature. This feature is disabled by
no fulltext search. default, so installing SOLR is optional.
When installing manually (i.e. not via docker), just install solr and When installing manually (i.e. not via docker), just install solr and
create a core as described in the [solr create a core as described in the [solr
@ -83,11 +83,21 @@ When using the provided `docker-compose.yml` setup, SOLR is already setup.
SOLR must be reachable from all joex and all rest server components. SOLR must be reachable from all joex and all rest server components.
{% infobubble(title="Multiple fulltext search backends") %}
Docspell can also use
[PostgreSQL](@/docs/configure/fulltext-search.md#postgresql) as its
fulltext search backend. This is not as powerful, but doesn't require
to install SOLR.
{% end %}
# Database # Database
Both components must have access to a SQL database. The SQL database Both components must have access to a SQL database. The SQL database
contains all data (including binary files) and is the central contains all data (including binary files by default) and is the
component of docspell. Docspell has support these databases: central component of docspell. Docspell has support these databases:
- PostreSQL - PostreSQL
- MariaDB - MariaDB