mirror of
https://github.com/TheAnachronism/docspell.git
synced 2025-06-20 17:39:54 +00:00
Update docs and changelog
This commit is contained in:
@ -38,6 +38,7 @@ description = "A list of features and limitations."
|
||||
with due dates
|
||||
- [Read your mailboxes](@/docs/webapp/scanmailbox.md) via IMAP to
|
||||
import mails into docspell
|
||||
- [Edit multiple items](@/docs/webapp/multiedit.md) at once
|
||||
- REST server and document processing are separate applications which
|
||||
can be scaled-out independently
|
||||
- Everything stored in a SQL database: PostgreSQL, MariaDB or H2
|
||||
|
52
website/site/content/docs/tools/consumedir-cleaner.md
Normal file
52
website/site/content/docs/tools/consumedir-cleaner.md
Normal file
@ -0,0 +1,52 @@
|
||||
+++
|
||||
title = "Directory Cleaner"
|
||||
description = "Clean directories from files in docspell"
|
||||
weight = 32
|
||||
+++
|
||||
|
||||
# Introduction
|
||||
|
||||
This script is made for cleaning up the consumption directory used for
|
||||
the consumedir service (as it is provided as docker container)which
|
||||
are copied or moved there.
|
||||
|
||||
<https://github.com/eikek/docspell/tree/master/tools/consumedir-cleaner>
|
||||
|
||||
## How it works
|
||||
|
||||
- Checks for every file (in the collective's folder of the given user
|
||||
name) if it already exists in the collective (using Docspell's API).
|
||||
- If so, by default those files are moved to an archive folder just
|
||||
besides the collective's consumption folders named _archive. The
|
||||
archive's files are organized into monthly subfolders by the date
|
||||
they've been added to Docspell
|
||||
- If set, those files can also be deleted instead of being moved to
|
||||
the archive. There is no undo function provided for this, so be
|
||||
careful.
|
||||
- If a file is found which does not exist in the collective, by
|
||||
default nothing happens, so that file would be found in every run
|
||||
and just ignored
|
||||
- If set, those files can also be uploaded to Docspell. Depending on
|
||||
the setting for files already existing these files would either be
|
||||
deleted or moved to the archive in the next run.
|
||||
|
||||
## Usage (parameters / settings)
|
||||
|
||||
Copy the script to your machine and run it with the following
|
||||
parameters:
|
||||
|
||||
1. URL of Docspell, including http(s)
|
||||
2. Username for Docspell, possibly including Collective (if other name
|
||||
as user)
|
||||
3. Password for Docspell
|
||||
4. Path to the directory which files shall be checked against
|
||||
existence in Docspell
|
||||
|
||||
Additionally, environment variables can be used to alter the behavior:
|
||||
|
||||
- `DS_CC_REMOVE`
|
||||
- `true` – delete files which already exist in the collective
|
||||
- `false` (default) - move them to the archive (see above)
|
||||
- `DS_CC_UPLOAD_MISSING`
|
||||
- `true` - uploads files which do not exist in the collective
|
||||
- `false` (default) - ignore them and do nothing
|
43
website/site/content/docs/tools/paperless-import.md
Normal file
43
website/site/content/docs/tools/paperless-import.md
Normal file
@ -0,0 +1,43 @@
|
||||
+++
|
||||
title = "Paperless Import"
|
||||
description = "Import your data from paperless."
|
||||
weight = 35
|
||||
+++
|
||||
|
||||
# Introduction
|
||||
|
||||
Coming from
|
||||
[paperless](https://github.com/the-paperless-project/paperless/), the
|
||||
script in `tools/import-paperless` can be used to get started by
|
||||
importing your data from paperless into docspell.
|
||||
|
||||
<https://github.com/eikek/docspell/tree/master/tools/import-paperless>
|
||||
|
||||
The script imports the files and also tags and correspondents.
|
||||
|
||||
# Usage
|
||||
|
||||
Copy the script to the machine where paperless is running. Run it with
|
||||
the following arguments:
|
||||
|
||||
1. URL of Docspell, including http(s)
|
||||
2. Username for Docspell, possibly including Collective (if other name as user)
|
||||
3. Password for Docspell
|
||||
4. Path to Paperless' database file (`db.sqlite3`). When using Paperless with docker, it is in the mapped directory `/usr/src/paperless/data`
|
||||
5. Path to Paperless' document base directory. When using Paperless with docker, it is the mapped directory `/usr/src/paperless/media/documents/origin/`
|
||||
|
||||
Some settings can be changed inside the script, right at the top:
|
||||
|
||||
* `LIMIT="LIMIT 0"` (default: inactive): For testing purposes, limits
|
||||
the number of tags and correspondents read from Paperless (this will
|
||||
most likely lead to warnings when processing the documents)
|
||||
* `LIMIT_DOC="LIMIT 5"` (default: inactive): For testing purposes,
|
||||
limits the number of documents and document-to-tag relations read
|
||||
from Paperless
|
||||
* `SKIP_EXISTING_DOCS=true` (default: true): Won't touch already
|
||||
existing documents. If set to `false` documents, which exist
|
||||
already, won't be uploaded again, but the tags, correspondent, date
|
||||
and title from Paperless will be applied.
|
||||
|
||||
**Warning** In case you already had set these information in Docspell,
|
||||
they will be overwritten!
|
Reference in New Issue
Block a user