Merge branch 'current-docs'

This commit is contained in:
eikek 2023-10-02 10:59:34 +02:00
commit 8f555e7e8c
2 changed files with 7 additions and 6 deletions

View File

@ -15,7 +15,7 @@ a `github` account to make this convenient.
The contents of this website is maintained in the [<i class="fab fa-github ml-1"></i> git
repository](https://github.com/eikek/docspell) in the `website/site`
folder. It is build by the static site generator
[zola](https://getzola.org) from a set of
[zola](https://www.getzola.org/) from a set of
[markdown](https://www.markdownguide.org/basic-syntax) files.
It is not necessary to know how everything is connected, you only need
@ -66,7 +66,7 @@ are required. The easiest way to get these is to install
[nix](https://nixos.org/) and run `nix-shell website/shell.nix` to get
an environment with all these tools installed. Otherwise install the
programs mentioned in `website/shell.nix`, which are:
[yarn](https://yarnpkg.com/), [zola](https://getzola.org),
[yarn](https://yarnpkg.com/), [zola](https://www.getzola.org/),
[elm](https://elm-lang.org) and [sbt](https://scala-sbt.org).
Then clone the sources to your machine and build the complete site

View File

@ -64,7 +64,7 @@ processes:
- REST server
- JOEX, short for *job executor*
- Fulltext Search Index (optional, currently Apache SOLR)
- Fulltext Search Index (optional, Apache SOLR or PostgreSQL)
The REST server provides the Api and the web application. The web
application is a
@ -84,9 +84,10 @@ database. And it is also recommended (though not strictly required),
that all components can reach each other.
The fulltext search index is another separate component, where
currently only [SOLR](https://solr.apache.org) is supported.
Fulltext search is optional, so the SOLR component is not required if
docspell is run without fulltext search support.
currently [SOLR](https://solr.apache.org) and
[PostgreSQL](https://www.postgresql.org/docs/current/textsearch.html)
is supported. Fulltext search is optional, this component is not
required if docspell is run without fulltext search support.
# Terms