TheAnachronism/docspell
1
0
Fork 0
mirror of https://github.com/TheAnachronism/docspell.git synced 2025-06-22 02:18:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Website redesign

Browse Source
This commit is contained in:
eikek
2022-01-27 20:23:15 +01:00
parent 3fc7f54f1a
commit 261d2af9bb
248 changed files with 3519 additions and 1484 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
website/site/content/docs/joex/file-processing.md
View File

@ -7,6 +7,8 @@ insert_anchor_links = "right"
mktoc = true
+++
# File Processing
When uploading a file, it is only saved to the database together with
the given meta information as a "job". The file is not visible in the
ui yet. Then joex takes the next such job and starts processing it.
@ -319,7 +321,7 @@ docspell.joex {
}
```
{% infobubble(mode="warning", title="Please note") %}
{% warningbubble(title="Please note") %}
When this is changed, you must re-generate all preview images. Check
the api for this, there is an endpoint to regenerate all preview

15
website/site/content/docs/joex/intro.md
View File

@ -7,7 +7,8 @@ insert_anchor_links = "right"
mktoc = true
+++
# Introduction
# Joex
## Introduction
Joex is short for *Job Executor* and it is the component managing long
running tasks in docspell. One of these long running tasks is the file
@ -30,7 +31,7 @@ compete on getting the next job from the queue. After a job finishes
and no job is waiting in the queue, joex will sleep until notified
again. It will also periodically notify itself as a fallback.
# Task vs Job
## Task vs Job
Just for the sake of this document, a task denotes the code that has
to be executed or the thing that has to be done. It emerges in a job,
@ -39,7 +40,7 @@ up and executed eventually. A job maintains a state and other things,
while a task is just code.
# Scheduler and Queue
## Scheduler and Queue
The scheduler is the part that runs and monitors the long running
jobs. It works together with the job queue, which defines what job to
@ -62,7 +63,7 @@ logged in, jobs are more important that those submitted when not
logged in.
# Scheduler Config
## Scheduler Config
The relevant part of the config file regarding the scheduler is shown
below with some explanations.
@ -130,7 +131,7 @@ reach a joex component. This periodic wakup is just to ensure that
jobs are eventually run.
# Periodic Tasks
## Periodic Tasks
The job executor can execute tasks periodically. These tasks are
stored in the database such that they can be submitted into the job
@ -139,7 +140,7 @@ something with a task. So a periodic task is never submitted twice. It
is also not submitted, if a previous task has not finished yet.
# Starting on demand
## Starting on demand
The job executor and rest server can be started multiple times. This
is especially useful for the job executor. For example, when
@ -154,7 +155,7 @@ Once the files have been processced you can stop the additional
executors.
# Shutting down
## Shutting down
If a job executor is sleeping and not executing any jobs, you can just
quit using SIGTERM or `Ctrl-C` when running in a terminal. But if