mirror of
https://github.com/TheAnachronism/docspell.git
synced 2025-06-05 22:55:58 +00:00
Documentation updates
This commit is contained in:
parent
0ba1736bc8
commit
c81b92af6d
@ -72,6 +72,61 @@ H2
|
|||||||
url = "jdbc:h2:///path/to/a/file.db;MODE=PostgreSQL;DATABASE_TO_LOWER=TRUE;AUTO_SERVER=TRUE"
|
url = "jdbc:h2:///path/to/a/file.db;MODE=PostgreSQL;DATABASE_TO_LOWER=TRUE;AUTO_SERVER=TRUE"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### Full-Text Search: SOLR
|
||||||
|
|
||||||
|
[Apache SOLR](https://lucene.apache.org/solr) is used to provide the
|
||||||
|
full-text search. Both docspell components must provide the same
|
||||||
|
connection setup. This is defined in the `full-text-search.solr`
|
||||||
|
subsection:
|
||||||
|
|
||||||
|
```
|
||||||
|
...
|
||||||
|
full-text-search {
|
||||||
|
enabled = true
|
||||||
|
...
|
||||||
|
solr = {
|
||||||
|
url = "http://localhost:8983/solr/docspell"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The default configuration at the end of this page contains more
|
||||||
|
information about each setting.
|
||||||
|
|
||||||
|
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
|
||||||
|
to `true`.
|
||||||
|
|
||||||
|
When installing docspell manually, just install solr and create a core
|
||||||
|
as described in the [solr
|
||||||
|
documentation](https://lucene.apache.org/solr/guide/8_4/installing-solr.html).
|
||||||
|
That will provide you with the connection url (the last part is the
|
||||||
|
core name).
|
||||||
|
|
||||||
|
While the `full-text-search.solr` options are the same for joex and
|
||||||
|
the restserver, there are some settings that differ. The restserver
|
||||||
|
has this additional setting, that may be of interest:
|
||||||
|
|
||||||
|
```
|
||||||
|
full-text-search {
|
||||||
|
recreate-key = "test123"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
This key is required if you want docspell to drop and re-create the
|
||||||
|
entire index. This is possible via a REST call:
|
||||||
|
|
||||||
|
``` shell
|
||||||
|
$ curl -XPOST http://localhost:7880/api/v1/open/fts/reIndexAll/test123
|
||||||
|
```
|
||||||
|
|
||||||
|
Here the `test123` is the key defined with `recreate-key`. If it is
|
||||||
|
empty (the default), this REST call is disabled. Otherwise, the POST
|
||||||
|
request will submit a system task that is executed by a joex instance
|
||||||
|
eventually.
|
||||||
|
|
||||||
|
|
||||||
### Bind
|
### Bind
|
||||||
|
|
||||||
The host and port the http server binds to. This applies to both
|
The host and port the http server binds to. This applies to both
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
layout: docs
|
layout: docs
|
||||||
title: Find and Review
|
title: Curate Metadata
|
||||||
permalink: doc/curate
|
permalink: doc/curate
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -11,13 +11,18 @@ permalink: features
|
|||||||
account)
|
account)
|
||||||
- Handle multiple documents as one unit
|
- Handle multiple documents as one unit
|
||||||
- OCR using [tesseract](https://github.com/tesseract-ocr/tesseract)
|
- OCR using [tesseract](https://github.com/tesseract-ocr/tesseract)
|
||||||
|
- [Full-Text Search](doc/finding#full-text-search) based on [Apache
|
||||||
|
SOLR](https://lucene.apache.org/solr)
|
||||||
- Conversion to PDF: all files are converted into a PDF file
|
- Conversion to PDF: all files are converted into a PDF file
|
||||||
- Non-destructive: all your uploaded files are never modified and can
|
- Non-destructive: all your uploaded files are never modified and can
|
||||||
always be downloaded untouched
|
always be downloaded untouched
|
||||||
- Text is analysed to find and attach meta data automatically
|
- Text is analysed to find and attach meta data automatically
|
||||||
- [Manage document processing](doc/processing): cancel jobs, set
|
- [Manage document processing](doc/processing): cancel jobs, set
|
||||||
priorities
|
priorities
|
||||||
- Everything available via a documented [REST Api](api)
|
- Everything available via a [documented](https://www.openapis.org/)
|
||||||
|
[REST Api](api); allows to [generate
|
||||||
|
clients](https://openapi-generator.tech/docs/generators) for
|
||||||
|
(almost) any language
|
||||||
- mobile-friendly Web-UI
|
- mobile-friendly Web-UI
|
||||||
- [Create “share-urls”](doc/uploading#anonymous-upload) to upload files
|
- [Create “share-urls”](doc/uploading#anonymous-upload) to upload files
|
||||||
anonymously
|
anonymously
|
||||||
@ -28,6 +33,8 @@ permalink: features
|
|||||||
- REST server and document processing are separate applications which
|
- REST server and document processing are separate applications which
|
||||||
can be scaled-out independently
|
can be scaled-out independently
|
||||||
- Everything stored in a SQL database: PostgreSQL, MariaDB or H2
|
- Everything stored in a SQL database: PostgreSQL, MariaDB or H2
|
||||||
|
- H2 is embedded, a "one-file-only" database, avoids installing db
|
||||||
|
servers
|
||||||
- Files supported:
|
- Files supported:
|
||||||
- Documents:
|
- Documents:
|
||||||
- PDF
|
- PDF
|
||||||
@ -55,8 +62,7 @@ permalink: features
|
|||||||
# Limitations
|
# Limitations
|
||||||
|
|
||||||
These are current known limitations that may be of interest for
|
These are current known limitations that may be of interest for
|
||||||
considering docspell at the moment. Hopefully they will be resolved
|
considering docspell at the moment.
|
||||||
eventually….
|
|
||||||
|
|
||||||
- No fulltext search implemented. This is now planned for an upcoming
|
- Documents cannot be modified.
|
||||||
release.
|
- You can remove and add documents but there is no versioning.
|
||||||
|
@ -33,15 +33,15 @@ options:
|
|||||||
- title: Finding Items
|
- title: Finding Items
|
||||||
url: doc/finding
|
url: doc/finding
|
||||||
|
|
||||||
|
- title: Curate Metadata
|
||||||
|
url: doc/curate
|
||||||
|
|
||||||
- title: Uploads
|
- title: Uploads
|
||||||
url: doc/uploading
|
url: doc/uploading
|
||||||
|
|
||||||
- title: Processing Queue
|
- title: Processing Queue
|
||||||
url: doc/processing
|
url: doc/processing
|
||||||
|
|
||||||
- title: Find and Review
|
|
||||||
url: doc/curate
|
|
||||||
|
|
||||||
- title: E-Mail Settings
|
- title: E-Mail Settings
|
||||||
url: doc/emailsettings
|
url: doc/emailsettings
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user