mirror of
https://github.com/TheAnachronism/docspell.git
synced 2025-03-28 09:45:07 +00:00
Use better fallback language for config files
This commit is contained in:
parent
8e1d32272e
commit
7dbbe03a56
@ -28,7 +28,7 @@ the current `/tmp` directory is configured.
|
||||
|
||||
The config looks like this (both components):
|
||||
|
||||
``` conf
|
||||
``` bash
|
||||
docspell.joex.jdbc {
|
||||
url = ...
|
||||
user = ...
|
||||
@ -81,7 +81,7 @@ full-text search. Both docspell components must provide the same
|
||||
connection setup. This is defined in the `full-text-search.solr`
|
||||
subsection:
|
||||
|
||||
``` conf
|
||||
``` bash
|
||||
...
|
||||
full-text-search {
|
||||
enabled = true
|
||||
@ -109,7 +109,7 @@ 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:
|
||||
|
||||
``` conf
|
||||
``` bash
|
||||
full-text-search {
|
||||
recreate-key = "test123"
|
||||
}
|
||||
@ -145,7 +145,7 @@ The host and port the http server binds to. This applies to both
|
||||
components. The joex component also exposes a small REST api to
|
||||
inspect its state and notify the scheduler.
|
||||
|
||||
``` conf
|
||||
``` bash
|
||||
docspell.server.bind {
|
||||
address = localhost
|
||||
port = 7880
|
||||
@ -190,7 +190,7 @@ be unique* for all instances. By default the REST server uses `rest1`
|
||||
and joex `joex1`. It is recommended to overwrite this setting to have
|
||||
an explicit and stable identifier.
|
||||
|
||||
``` conf
|
||||
``` bash
|
||||
docspell.server.app-id = "rest1"
|
||||
docspell.joex.app-id = "joex1"
|
||||
```
|
||||
@ -206,7 +206,7 @@ options:
|
||||
|
||||
This applies only to the REST sevrer component.
|
||||
|
||||
``` conf
|
||||
``` bash
|
||||
docspell.server.signup {
|
||||
mode = "open"
|
||||
|
||||
@ -246,7 +246,7 @@ token can be given as a normal http header or via a cookie header.
|
||||
|
||||
These settings apply only to the REST server.
|
||||
|
||||
``` conf
|
||||
``` bash
|
||||
docspell.server.auth {
|
||||
server-secret = "hex:caffee" # or "b64:Y2FmZmVlCg=="
|
||||
session-valid = "5 minutes"
|
||||
|
@ -36,7 +36,7 @@ The sbt build is setup such that a file `dev.conf` in the directory
|
||||
it exists. So you can create a custom config file for development. For
|
||||
example, a custom database for development may be setup this way:
|
||||
|
||||
``` conf
|
||||
``` bash
|
||||
#jdbcurl = "jdbc:h2:///home/dev/workspace/projects/docspell/local/docspell-demo.db;MODE=PostgreSQL;DATABASE_TO_LOWER=TRUE;AUTO_SERVER=TRUE"
|
||||
jdbcurl = "jdbc:postgresql://localhost:5432/docspelldev"
|
||||
#jdbcurl = "jdbc:mariadb://localhost:3306/docspelldev"
|
||||
|
@ -21,7 +21,7 @@ configuration file:
|
||||
to change the `bind.address` setting to be either `0.0.0.0` or the
|
||||
ip address of the network interface that the reverse proxy server
|
||||
connects to.
|
||||
``` conf
|
||||
``` bash
|
||||
docspell.server {
|
||||
# Where the server binds to.
|
||||
bind {
|
||||
@ -35,7 +35,7 @@ configuration file:
|
||||
- Docspell needs to know the external url. The `base-url` setting
|
||||
must point to the external address. Using above values, it must be
|
||||
set to `https://docspell.example.com`.
|
||||
``` conf
|
||||
``` bash
|
||||
docspell.server {
|
||||
# This is the base URL this application is deployed to. This is used
|
||||
# to create absolute URLs and to configure the cookie.
|
||||
@ -61,7 +61,7 @@ The https server endpoint is configured with the let's encrypt
|
||||
certificates and acts as a proxy for the application at
|
||||
`192.168.1.11:7880`.
|
||||
|
||||
``` conf
|
||||
``` bash
|
||||
server {
|
||||
listen 0.0.0.0:80 ;
|
||||
listen [::]:80 ;
|
||||
|
@ -67,7 +67,7 @@ logged in.
|
||||
The relevant part of the config file regarding the scheduler is shown
|
||||
below with some explanations.
|
||||
|
||||
``` conf
|
||||
``` bash
|
||||
docspell.joex {
|
||||
# other settings left out for brevity
|
||||
|
||||
|
@ -94,7 +94,7 @@ docker build -t ds-exim:latest -f exim.dockerfile .
|
||||
Then start docspell somewhere and configure the integration endpoint
|
||||
to use http-header protection; i.e. set this in the config file:
|
||||
|
||||
``` conf
|
||||
``` bash
|
||||
docspell.server {
|
||||
integration-endpoint {
|
||||
enabled = true
|
||||
|
@ -1,4 +1,4 @@
|
||||
``` conf
|
||||
``` bash
|
||||
{% set data = load_data(path=path) %}
|
||||
{{ data | safe }}
|
||||
```
|
||||
|
Loading…
x
Reference in New Issue
Block a user