mirror of
https://github.com/TheAnachronism/docspell.git
synced 2025-06-22 02:18:26 +00:00
Merge branch 'current-docs'
This commit is contained in:
@ -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
|
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`
|
repository](https://github.com/eikek/docspell) in the `website/site`
|
||||||
folder. It is build by the static site generator
|
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.
|
[markdown](https://www.markdownguide.org/basic-syntax) files.
|
||||||
|
|
||||||
It is not necessary to know how everything is connected, you only need
|
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
|
[nix](https://nixos.org/) and run `nix-shell website/shell.nix` to get
|
||||||
an environment with all these tools installed. Otherwise install the
|
an environment with all these tools installed. Otherwise install the
|
||||||
programs mentioned in `website/shell.nix`, which are:
|
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).
|
[elm](https://elm-lang.org) and [sbt](https://scala-sbt.org).
|
||||||
|
|
||||||
Then clone the sources to your machine and build the complete site
|
Then clone the sources to your machine and build the complete site
|
||||||
|
@ -64,7 +64,7 @@ processes:
|
|||||||
|
|
||||||
- REST server
|
- REST server
|
||||||
- JOEX, short for *job executor*
|
- 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
|
The REST server provides the Api and the web application. The web
|
||||||
application is a
|
application is a
|
||||||
@ -84,9 +84,10 @@ database. And it is also recommended (though not strictly required),
|
|||||||
that all components can reach each other.
|
that all components can reach each other.
|
||||||
|
|
||||||
The fulltext search index is another separate component, where
|
The fulltext search index is another separate component, where
|
||||||
currently only [SOLR](https://solr.apache.org) is supported.
|
currently [SOLR](https://solr.apache.org) and
|
||||||
Fulltext search is optional, so the SOLR component is not required if
|
[PostgreSQL](https://www.postgresql.org/docs/current/textsearch.html)
|
||||||
docspell is run without fulltext search support.
|
is supported. Fulltext search is optional, this component is not
|
||||||
|
required if docspell is run without fulltext search support.
|
||||||
|
|
||||||
|
|
||||||
# Terms
|
# Terms
|
||||||
|
Reference in New Issue
Block a user