Assist in organizing your piles of documents, resulting from scanners, e-mails and other sources with miminal effort.
Go to file
2020-05-27 16:28:35 +00:00
artwork Upgrade microsite 2019-12-30 02:33:46 +01:00
docker Add a docker image for watching a directory 2020-05-25 19:43:06 +02:00
modules Remove references to pdf in the doc 2020-05-27 00:44:04 +02:00
nix Update nix and docker setups 2020-05-25 17:57:41 +02:00
project Update flyway-core to 6.4.3 2020-05-27 18:21:10 +02:00
tools Remove references to pdf in the doc 2020-05-27 00:44:04 +02:00
.gitignore Add support for integrating into nix/nixos 2020-01-20 00:21:15 +01:00
.mergify.yml Add mergify config 2020-05-12 01:14:11 +02:00
.scala-steward.conf Don't update stanford-nlp just yet 2020-04-22 21:06:42 +02:00
.scalafmt.conf Update scalafmt-core to 2.5.3 2020-05-26 04:35:22 +02:00
.travis.yml Update scala to 2.13.2 2020-04-24 22:24:31 +02:00
build.sbt Joex depends on backend module 2020-05-10 21:03:12 +02:00
Changelog.md Update changelog and small doc fixes 2020-05-25 17:29:50 +02:00
elm-analyse.json Fix elm-analyse issues 2020-01-29 20:56:14 +01:00
elm-package.json Add scalafmt.conf and elm compile options 2019-12-29 20:52:43 +01:00
elm.json Change attachments position via drag-and-drop 2020-05-24 17:30:25 +02:00
LICENSE.txt Initial version. 2019-09-21 22:02:36 +02:00
NOTICE.txt Improve handling encodings 2020-03-23 22:51:28 +01:00
README.md Fix typo in README 2020-05-23 09:26:07 +02:00
version.sbt Set version to 0.7.0-SNAPSHOT 2020-05-25 17:58:05 +02:00

Build Status Scala Steward badge

Docspell

Docspell is a personal document organizer. You'll need a scanner to convert your papers into PDF files. Docspell can then assist in organizing the resulting mess 😉.

You can associate tags, set correspondends, what a document is concerned with, a name, a date and some more. If your documents are associated with this meta data, you should be able to quickly find them later using the search feature. But adding this manually to each document is a tedious task. What if most of it could be done automatically?

It is provided as a REST server and a web application.

How it works

Documents have two main properties: a correspondent (sender or receiver that is not you) and something the document is about. Usually it is about a person or some thing maybe your car, or contracts concerning some familiy member, etc.

  1. You maintain a kind of address book. It should list all possible correspondents and the concerning people/things. This grows incrementally with each new unknown document.
  2. When docspell analyzes a document, it tries to find matches within your address book. It can detect the correspondent and a concerning person or thing. It will then associate this data to your documents.
  3. You can inspect what docspell has done and correct it. If docspell has found multiple suggestions, they will be shown for you to select one. If it is not correctly associated, very often the correct one is just one click away.

The set of meta data, that docspell uses to draw suggestions from, must be maintained manually. But usually, this data doesn't grow as fast as the documents. After a while there is a quite complete address book and only once in a while it has to be revisited.

Install

Documentation

The documentation site provides more information.

Check the feature list and the quickstart guide to try it out:

Screenshots

Here are some (outdated) screenshots, for getting a first impression of the web ui.

screenshot-1 screenshot-2 screenshot-3