docspell/website/site/content/docs/feed/_index.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

139 lines
4.8 KiB
Markdown
Raw Normal View History

2020-08-21 22:18:56 +00:00
+++
2022-03-21 20:04:19 +00:00
title = "Documents → Docspell"
2022-01-27 19:23:15 +00:00
weight = 8
2020-08-21 22:18:56 +00:00
description = "Shows several ways for getting data into Docspell."
insert_anchor_links = "right"
2022-01-27 19:23:15 +00:00
template = "docs.html"
2020-08-21 22:18:56 +00:00
[extra]
mktoc = true
+++
2022-01-27 19:23:15 +00:00
# Documents → Docspell
2020-08-21 22:18:56 +00:00
One of the main goals is to stow documents away quickly.
Docspell makes no assumptions about where your documents are. It
offers just one HTTP endpoint that accepts files. (Well, technically
you create them in the webapp, and you can create many of them.) This
endpoint is designed to work conveniently with tools like
[curl](https://curl.haxx.se/) and it should be easy to use from other
languages, too.
So the idea is to have most flexibility that is, it is up to you how
documents arrive. Of course, there is something prepared:
2022-01-27 19:23:15 +00:00
## Upload in Webapp
2020-08-21 22:18:56 +00:00
This is the simplest way, but also the least flexible. You can just
login and go to the upload page to submit files.
2022-01-27 19:23:15 +00:00
{{ figure2(light="web-upload.png", dark="web-upload_dark.png") }}
2020-08-21 22:18:56 +00:00
This requires to login at the webapp. Since this is complicated from
other applications, you can create custom hard-to-guess endpoints to
use with the following options.
2022-01-27 19:23:15 +00:00
## Scanners / Watch Directories
2020-08-21 22:18:56 +00:00
If you have a (document) scanner (or think about getting one), it can
usually be configured to place scanned documents as image or PDF files
2021-10-25 17:28:26 +00:00
on your NAS. On your NAS, run `dsc watch` as a service (there is a
docker container to get started) that watches this directory and
uploads all incoming files to Docspell. The [dsc
tool](@/docs/tools/cli.md) can watch directories recursively and can
skip files already uploaded, so you can organize the files as you want
in there (rename, move etc).
2020-08-21 22:18:56 +00:00
2021-01-25 07:50:46 +00:00
This can be used multiple times on different machines, if desired.
2020-08-21 22:18:56 +00:00
The scanner should support 300dpi for better results. Docspell
converts the files into PDF adding a text layer of image-only files.
2021-01-10 19:06:30 +00:00
Check out
[scanadf2docspell](https://github.com/eresturo/scanadf2docspell) if
your scanner is connected to your computer. This can create nice pdf
files from scanners with ADF, applying corrections and sending them to
docspell.
2022-01-27 19:23:15 +00:00
{{ buttonright(href="/docs/tools/cli#watch-a-directory", text="More") }}
2020-08-21 22:18:56 +00:00
2022-01-27 19:23:15 +00:00
## Android
2020-08-21 22:18:56 +00:00
2020-09-07 13:05:03 +00:00
There is an [android
2020-09-24 18:21:53 +00:00
client](https://github.com/docspell/android-client) provided that lets
you upload files from your android devices. The idea is to use a
separate app, like
2020-08-21 22:18:56 +00:00
[OpenNoteScanner](https://github.com/ctodobom/OpenNoteScanner), to
"scan" documents using your phone/tablet and then upload it to
Docspell. For the upload part, you can use the provided app. It hooks
into the Share-With menu and uploads the file to Docspell.
This is especially useful to quickly upload small things like shopping
receipts.
2022-01-27 19:23:15 +00:00
<div class="grid grid-cols-2 gap-8 divide-x ">
<div class="flex items-center justify-center">
2020-09-24 18:21:53 +00:00
<a href="https://f-droid.org/packages/org.docspell.docspellshare">
<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
2022-01-27 19:23:15 +00:00
alt="Get it on F-Droid"
class="w-56"
/>
2020-09-24 18:21:53 +00:00
</a>
</div>
2022-01-27 19:23:15 +00:00
<div class="flex items-center justify-center text-xl">
<i class="fa fa-download mr-2"></i>
<span>
<a href="https://github.com/docspell/android-client/releases/latest">Download the APK</a>
</span>
2020-09-24 18:21:53 +00:00
</div>
2022-01-27 19:23:15 +00:00
2020-09-24 18:21:53 +00:00
</div>
2020-08-21 22:18:56 +00:00
2022-01-27 19:23:15 +00:00
{{ buttonright(href="/docs/tools/android", text="More") }}
2020-08-21 22:18:56 +00:00
2022-01-27 19:23:15 +00:00
## Poll E-Mails
2020-08-21 22:18:56 +00:00
Your mailbox can be polled periodically to import mails. For example,
create a dedicated folder in your e-mail client and move mails in
there that you want to push to Docspell. You can then define a
recurring job, that looks into this folders and imports the mails.
2022-01-27 19:23:15 +00:00
{{ figure2(light="scanmailbox.png", dark="scanmailbox_dark.png") }}
2020-08-21 22:18:56 +00:00
2022-01-27 19:23:15 +00:00
{{ buttonright(href="/docs/webapp/scanmailbox", text="More") }}
2020-08-21 22:18:56 +00:00
2022-01-27 19:23:15 +00:00
## E-Mail Server
2020-08-21 22:18:56 +00:00
This is a little more involved, but can be quite nice. A SMTP server
can be setup that simply uploads incoming mails to Docspell (using
curl), instead of storing the mails on disk. This requires some
knowledge to setup such a server and it makes sense to own a domain.
2020-09-02 19:44:13 +00:00
Or it can be used internally to connect devices like scanners that
offer a scan-to-mail option. The SMTP server would accept mails to
*[your-username]@[your-domain]* and resolves the *[your-username]*
part in Docspell to upload the files to the correct account.
2020-08-21 22:18:56 +00:00
There is a docker container prepared to get started. Click below to
read more.
2022-01-27 19:23:15 +00:00
{{ buttonright(href="/docs/tools/smtpgateway", text="More") }}
2020-08-21 22:18:56 +00:00
2022-01-27 19:23:15 +00:00
## Command-Line
2020-08-21 22:18:56 +00:00
2021-07-28 21:25:01 +00:00
I like to use the command line, and so there is a cli that can be used
for some tasks, for example uploading files. Below is a quick demo, it
supports many more options, see the link below for details.
2020-08-21 22:18:56 +00:00
2022-01-27 19:23:15 +00:00
<figure>
<script id="asciicast-427679" src="https://asciinema.org/a/427679.js" async></script>
</figure>
2020-08-21 22:18:56 +00:00
2022-01-27 19:23:15 +00:00
{{ buttonright(href="/docs/tools/cli", text="More") }}