Update microsite

This commit is contained in:
Eike Kettner
2020-03-28 16:35:28 +01:00
parent 4429c0a490
commit e331808ecf
38 changed files with 100 additions and 71 deletions

View File

@ -1,6 +1,7 @@
---
layout: docs
title: Configuring
permalink: doc/configure
---
# {{ page.title }}

View File

@ -1,6 +1,7 @@
---
layout: docs
title: Find and Review
permalink: doc/curate
---
# {{page.title}}

View File

@ -1,12 +1,13 @@
---
layout: docs
title: Installation
permalink: doc/install
---
# {{ page.title }}
This page contains detailed installation instructions. For a quick
start, refer to [this page](../getit.html).
start, refer to [this page](../getit).
Docspell has been developed and tested on a GNU/Linux system. It may
run on Windows and MacOS machines, too (ghostscript and tesseract are
@ -29,7 +30,7 @@ While this is possible, the simple setup is to start both components
once on the same machine.
The [download page](https://github.com/eikek/docspell/releases)
provides pre-compiled packages and the [development page](dev.html)
provides pre-compiled packages and the [development page](../dev)
contains build instructions.
@ -112,7 +113,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 [default config](configure.html) for an example.
of the url. See the [config page](configure#jdbc) for an example.
## Installing from ZIP files
@ -149,9 +150,9 @@ $ ./docspell-joex*/bin/docspell-joex
This will startup both components using the default configuration. The
configuration should be adopted to your needs. For example, the
database connection is configured to use a H2 database in the `/tmp`
directory. Please refer to the [configuration page](configure.html)
for how to create a custom config file. Once you have your config
file, simply pass it as argument to the command:
directory. Please refer to the [configuration page](configure) 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
@ -163,7 +164,7 @@ path `/app`, so using default values it would be
`http://localhost:7880/app`.
You should be able to create a new account and sign in. Check the
[configuration page](configure.html) to further customize docspell.
[configuration page](configure) to further customize docspell.
### Options

View File

@ -1,6 +1,7 @@
---
layout: docs
title: Joex
permalink: doc/joex
---
# {{ page.title }}
@ -17,7 +18,7 @@ parallel is limited with respect to the hardware it is running on.
For larger installations, it is probably better to run several joex
components on different machines. That works out of the box, as long
as all components point to the same database and use different
`app-id`s (see [configuring docspell](./configure.html)).
`app-id`s (see [configuring docspell](./configure#app-id)).
When files are submitted to docspell, they are stored in the database
and all known joex components are notified about new work. Then they
@ -50,10 +51,10 @@ next. The default is `4, 1`, meaning to first select 4 high priority
jobs and then 1 low priority job, then starting over. If no such job
exists, its falls back to the other priority.
The priority can be set on a *Source* (see
[uploads](uploading.html)). Uploading through the web application will
always use priority *high*. The idea is that while logged in, jobs are
more important that those submitted when not logged in.
The priority can be set on a *Source* (see [uploads](uploading)).
Uploading through the web application will always use priority *high*.
The idea is that while logged in, jobs are more important that those
submitted when not logged in.
## Scheduler Config

View File

@ -1,6 +1,7 @@
---
layout: docs
title: Send items via E-Mail
permalink: doc/mailitem
---
# {{page.title}}

View File

@ -1,21 +1,26 @@
---
layout: docs
title: Adding Meta Data
permalink: doc/metadata
---
# {{ page.title }}
## Meta Data
The processing can be controlled implicitely by the provided meta
data. The *Meta Data* page allows to manage this meta data. You can
create the following:
Docspell processes each uploaded file. Processing involves extracting
archives, extracting text, anlyzing the extracted text and converting
the file into a pdf. Text is analyzed to find metadata that can be set
automatically. Docspell compares the extracted text against a set of
known meta data. The *Meta Data* page allows to manage this meta data.
You can create the following:
- Tags
- Organizations
- Persons
- Equipments
### Tags
Items can be tagged with multiple custom tags (aka labels). This
@ -32,7 +37,7 @@ can help to implement some.
The tags are *not* taken into account when processing. Docspell will
not automatically associate tags to your items. The tags are only
meant to be used manually.
meant to be used manually for now.
### Organization and Person

View File

@ -1,6 +1,7 @@
---
layout: docs
title: Processing Queue
permalink: doc/processing
---
# {{ page.title }}

View File

@ -1,6 +1,7 @@
---
layout: docs
title: Tools
permalink: doc/tools
---
# {{ page.title }}
@ -65,7 +66,7 @@ ExecStart=/bin/su -s /bin/bash someuser -c "consumedir.sh --path '/a/path/' -m '
This unit file is just an example, it needs some fiddling. It assumes
an existing user `someuser` that is used to run this service. The url
`http://localhost:7880/api/v1/open/upload/...` is an anonymous upload
url as described [here](./uploading.html).
url as described [here](./uploading#anonymous-upload).
## ds.sh
@ -88,7 +89,7 @@ url.2 = http://localhost:7880/api/v1/open/upload/item/6DxhjkvWf9S-CkWqF3Kr892-Wg
```
The key must start with `url`. The urls should be [anonymous upload
urls](./uploading.html).
urls](./uploading#anonymous-upload).
### Usage

View File

@ -1,6 +1,7 @@
---
layout: docs
title: Uploads
permalink: doc/uploading
---
# {{page.title}}