mirror of
https://github.com/TheAnachronism/docspell.git
synced 2025-06-22 02:18:26 +00:00
Move default config into separate file
This commit is contained in:
@ -23,7 +23,7 @@ not prepare for each addon, it is recommended to install
|
|||||||
and docker on the machine running joex.
|
and docker on the machine running joex.
|
||||||
|
|
||||||
Please also look at addon section in the [default
|
Please also look at addon section in the [default
|
||||||
configuration](@/docs/configure/main.md#joex) for joex.
|
configuration](@/docs/configure/defaults.md#joex) for joex.
|
||||||
|
|
||||||
You need to explicitly enable addons in the restserver config file.
|
You need to explicitly enable addons in the restserver config file.
|
||||||
|
|
||||||
@ -235,4 +235,4 @@ When joex is not inside a container:
|
|||||||
- Allow the user who runs the joex component to use docker and nix. If
|
- Allow the user who runs the joex component to use docker and nix. If
|
||||||
you install nix as multi-user, then this is already done.
|
you install nix as multi-user, then this is already done.
|
||||||
- Check the section on addons in the [default
|
- Check the section on addons in the [default
|
||||||
configuration](@/docs/configure/main.md#joex) for joex
|
configuration](@/docs/configure/defaults.md#joex) for joex
|
||||||
|
@ -163,7 +163,7 @@ on the same host or network).
|
|||||||
|
|
||||||
The endpoint is disabled by default, an admin must change the
|
The endpoint is disabled by default, an admin must change the
|
||||||
`docspell.server.integration-endpoint.enabled` flag to `true` in the
|
`docspell.server.integration-endpoint.enabled` flag to `true` in the
|
||||||
[configuration file](@/docs/configure/main.md#rest-server).
|
[configuration file](@/docs/configure/defaults.md#rest-server).
|
||||||
|
|
||||||
If queried by a `GET` request, it returns whether it is enabled and
|
If queried by a `GET` request, it returns whether it is enabled and
|
||||||
the collective exists.
|
the collective exists.
|
||||||
|
@ -46,7 +46,7 @@ an OpenID Provider (OP) somewhere and to configure Docspell
|
|||||||
accordingly to act as the relying party.
|
accordingly to act as the relying party.
|
||||||
|
|
||||||
You can define multiple OPs to use. For some examples, please see the
|
You can define multiple OPs to use. For some examples, please see the
|
||||||
[default configuration](@/docs/configure/main.md#default-config).
|
[default configuration](@/docs/configure/defaults.md).
|
||||||
|
|
||||||
The configuration of a provider highly depends on how it is setup.
|
The configuration of a provider highly depends on how it is setup.
|
||||||
Here is an example for a setup using
|
Here is an example for a setup using
|
||||||
|
50
website/site/content/docs/configure/defaults.md
Normal file
50
website/site/content/docs/configure/defaults.md
Normal file
@ -0,0 +1,50 @@
|
|||||||
|
+++
|
||||||
|
title = "Default Configuration"
|
||||||
|
insert_anchor_links = "right"
|
||||||
|
description = "Shows the default settings."
|
||||||
|
weight = 100
|
||||||
|
template = "docs.html"
|
||||||
|
+++
|
||||||
|
|
||||||
|
## Default Configuration
|
||||||
|
|
||||||
|
Below is the default config file for the restserver and joex. If you
|
||||||
|
create a config file, you only need to include settings that differ
|
||||||
|
from the default config.
|
||||||
|
|
||||||
|
## Rest Server
|
||||||
|
|
||||||
|
{{ incl_conf(path="templates/shortcodes/server.conf") }}
|
||||||
|
|
||||||
|
|
||||||
|
## Joex
|
||||||
|
|
||||||
|
{{ incl_conf(path="templates/shortcodes/joex.conf") }}
|
||||||
|
|
||||||
|
|
||||||
|
## Environment Variables
|
||||||
|
|
||||||
|
Environment variables can be used when there is no config file
|
||||||
|
supplied.
|
||||||
|
|
||||||
|
There is one caveat: The configuration files above reuse values by
|
||||||
|
referencing them. This applies for example to the `app-id` - it is
|
||||||
|
used at other places, where the config file simply references it via
|
||||||
|
its full path. For example for the scheduler name, the default value
|
||||||
|
is `${docspell.joex.app-id}`. This way the value of `scheduler.name`
|
||||||
|
is always the same as `app-id`. But this doesn't work with env
|
||||||
|
variables! Here you'd need to update each such value.
|
||||||
|
|
||||||
|
For example, when creating multiple joex', they must have different
|
||||||
|
`app-id`s and with this, these values need to be set as well:
|
||||||
|
|
||||||
|
```
|
||||||
|
DOCSPELL_JOEX_APP__ID=joex2
|
||||||
|
DOCSPELL_JOEX_PERIODIC__SCHEDULER_NAME=joex2
|
||||||
|
DOCSPELL_JOEX_SCHEDULER_NAME=joex2
|
||||||
|
```
|
||||||
|
|
||||||
|
The listing below shows all possible variables and their default
|
||||||
|
values.
|
||||||
|
|
||||||
|
{{ incl_conf(path="templates/shortcodes/config.env.txt") }}
|
@ -47,7 +47,7 @@ read and write permissions.
|
|||||||
{% end %}
|
{% end %}
|
||||||
|
|
||||||
The file storage backend can be configured inside the `files` section
|
The file storage backend can be configured inside the `files` section
|
||||||
(see the [default configs](@/docs/configure/main.md#default-config)):
|
(see the [default configs](@/docs/configure/defaults.md)):
|
||||||
|
|
||||||
```conf
|
```conf
|
||||||
files {
|
files {
|
||||||
|
@ -14,7 +14,7 @@ configuration is in this config only.
|
|||||||
File processing involves several stages, detailed information can be
|
File processing involves several stages, detailed information can be
|
||||||
found [here](@/docs/joex/file-processing.md#text-analysis) and in the
|
found [here](@/docs/joex/file-processing.md#text-analysis) and in the
|
||||||
corresponding sections in [joex default
|
corresponding sections in [joex default
|
||||||
config](@/docs/configure/main.md#joex).
|
config](@/docs/configure/defaults.md#joex).
|
||||||
|
|
||||||
Configuration allows to define the external tools and set some
|
Configuration allows to define the external tools and set some
|
||||||
limitations to control memory usage. The sections are:
|
limitations to control memory usage. The sections are:
|
||||||
|
@ -49,7 +49,7 @@ subsection:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
The [default configuration](@/docs/configure/main.md#default-config)
|
The [default configuration](@/docs/configure/defaults.md)
|
||||||
contains more 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
|
||||||
|
@ -176,22 +176,3 @@ via environment variables. There are these settings:
|
|||||||
The default settings for joex and restserver are the same and
|
The default settings for joex and restserver are the same and
|
||||||
configure a minimum level of `Warn` and override some loggers with
|
configure a minimum level of `Warn` and override some loggers with
|
||||||
`Info`.
|
`Info`.
|
||||||
|
|
||||||
# Default Config
|
|
||||||
## Rest Server
|
|
||||||
|
|
||||||
{{ incl_conf(path="templates/shortcodes/server.conf") }}
|
|
||||||
|
|
||||||
|
|
||||||
## Joex
|
|
||||||
|
|
||||||
|
|
||||||
{{ incl_conf(path="templates/shortcodes/joex.conf") }}
|
|
||||||
|
|
||||||
## Environment Variables
|
|
||||||
|
|
||||||
Environment variables can be used when there is no config file
|
|
||||||
supplied. The listing below shows all possible variables and their
|
|
||||||
default values.
|
|
||||||
|
|
||||||
{{ incl_conf(path="templates/shortcodes/config.env.txt") }}
|
|
||||||
|
@ -80,7 +80,7 @@ line are required. As you see for `wkhtmltopdf` the page size is fixed
|
|||||||
to DIN A4. Other commands are configured like this as well.
|
to DIN A4. Other commands are configured like this as well.
|
||||||
|
|
||||||
For the default values, please see the [configuration
|
For the default values, please see the [configuration
|
||||||
page](@/docs/configure/main.md#joex).
|
page](@/docs/configure/defaults.md#joex).
|
||||||
|
|
||||||
## Duplicate Check
|
## Duplicate Check
|
||||||
|
|
||||||
|
@ -19,7 +19,7 @@ _UI Settings_. Among other things, there is a _Item Cards_ section:
|
|||||||
This defines how many of the item notes to display in the card. You
|
This defines how many of the item notes to display in the card. You
|
||||||
can set it to `0` to not show any notes at all. This is only a "soft
|
can set it to `0` to not show any notes at all. This is only a "soft
|
||||||
limit", there is also a "hard limit" in [docspell's
|
limit", there is also a "hard limit" in [docspell's
|
||||||
configuration](@/docs/configure/main.md#rest-server) (see
|
configuration](@/docs/configure/defaults.md#rest-server) (see
|
||||||
`max-note-length`), that is an upper limit to this value.
|
`max-note-length`), that is an upper limit to this value.
|
||||||
|
|
||||||
### Size of item preview
|
### Size of item preview
|
||||||
@ -27,7 +27,7 @@ configuration](@/docs/configure/main.md#rest-server) (see
|
|||||||
The item preview is an image of the first page of the first
|
The item preview is an image of the first page of the first
|
||||||
attachment. You can change the order of attachments in the item detail
|
attachment. You can change the order of attachments in the item detail
|
||||||
view. This image has a predefined size, which is specified [docspell's
|
view. This image has a predefined size, which is specified [docspell's
|
||||||
configuration](@/docs/configure/main.md#joex) (see
|
configuration](@/docs/configure/defaults.md#joex) (see
|
||||||
`extraction.preview.dpi`). The size for displaying it, can be
|
`extraction.preview.dpi`). The size for displaying it, can be
|
||||||
specified via this setting. A _small_ preview uses about 80px width, a
|
specified via this setting. A _small_ preview uses about 80px width, a
|
||||||
_medium_ one 160px and _large_ means to use the available space in the
|
_medium_ one 160px and _large_ means to use the available space in the
|
||||||
|
@ -191,7 +191,7 @@ file to look for duplicates, too.
|
|||||||
|
|
||||||
Docspell will go through all folders and download mails in “batches”.
|
Docspell will go through all folders and download mails in “batches”.
|
||||||
This size can be set by the admin in the [configuration
|
This size can be set by the admin in the [configuration
|
||||||
file](@/docs/configure/main.md#joex) and applies to all these
|
file](@/docs/configure/defaults.md#joex) and applies to all these
|
||||||
tasks (same for all users). This batch only contains the mail headers
|
tasks (same for all users). This batch only contains the mail headers
|
||||||
and not the complete mail.
|
and not the complete mail.
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user