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

Reorganize docs about configuration

Browse Source
This commit is contained in:
eikek
2022-03-21 14:41:39 +01:00
parent 3e87feff7b
commit 5de6c8940d
23 changed files with 1014 additions and 917 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -74,9 +74,10 @@ $ ./docspell-joex*/bin/docspell-joex
```
This will startup both components using the default configuration.
Please refer to the [configuration page](@/docs/configure/_index.md)
for how to create a custom config file. Once you have your config
file, simply pass it as argument to the command:
Please refer to the [configuration
page](@/docs/configure/main.md) for how to create a custom
config file. Once you have your config file, simply pass it as
argument to the command:
```
$ ./docspell-restserver*/bin/docspell-restserver /path/to/server-config.conf
@ -110,7 +111,7 @@ Fulltext search is powered by [SOLR](https://solr.apache.org). You
need to install solr and create a core for docspell. Then cange the
solr url for both components (restserver and joex) accordingly. See
the relevant section in the [config
page](@/docs/configure/_index.md#full-text-search).
page](@/docs/configure/fulltext-search.md).
### Watching a directory

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

@ -102,7 +102,7 @@ When using H2, make sure that all components access the same database
– the jdbc url must point to the same file. Then, it is important to
add the options
`;MODE=PostgreSQL;DATABASE_TO_LOWER=TRUE;AUTO_SERVER=TRUE` at the end
of the url. See the [config page](@/docs/configure/_index.md#jdbc) for
of the url. See the [config page](@/docs/configure/database.md) for
an example.
For large installations, PostgreSQL or MariaDB is recommended. Create

8
website/site/content/docs/install/rpi.md
View File

@ -30,10 +30,10 @@ result in long processing times for OCR and text analysis. The board
should provide 4G of RAM (like the current RPi4), especially if also a
database and solr are running next to it. The memory required by joex
depends on the config and document language. Please pick a value that
suits your setup from [here](@/docs/configure/_index.md#memory-usage).
For boards like the RPi, it might be necessary to use
`nlp.mode=basic`, rather than `nlp.mode=full`. You should also set the
joex pool size to 1.
suits your setup from
[here](@/docs/configure/file-processing.md#memory-usage). For boards
like the RPi, it might be necessary to use `nlp.mode=basic`, rather
than `nlp.mode=full`. You should also set the joex pool size to 1.
An example: on this [UP
board](https://up-board.org/up/specifications/) with an Intel Atom