Docspell aims to be a simple yet effective document organizer that makes stowing documents away very quick and finding them later reliable (and also fast). It doesn't require technical background or studying huge manuals in order to use it. With this in mind, it is rather opinionated and more targeted for home use and small/medium organizations.
Docspell analyzes the text of your files and tries to find metadata that will be annotated automatically. This metadata is taken from an address book that must be maintained manually. Docspell then looks for candidates for:
It will propose a few candidates and sets the most likely one to your item.
This might be wrong, so it is recommended to curate the results. However, very often the correct one is either set or within the proposals where you fix it by a single click.
Besides these properties, there are more metadata you can use to organize your files, for example tags, folders and notes.
Docspell is also for programmers. Everything is available via a REST
or HTTP api and can be easily used within your own scripts and tools,
for example using
curl. There are also features for "advanced use"
and many configuration options.
Docspell consists of multiple components that run in separate processes:
The joex is the component that does the “heavy work”, executing long-running tasks, like processing files or importing your mails periodically. While the joex component also exposes a small REST api for controlling it, the main user interface is all inside the rest server api.
The rest server and the job executor can be started multiple times in order to scale out. It must be ensured, that all connect to the same database. And it is also recommended (though not strictly required), that all components can reach each other.
The fulltext search index is another separate component, where currently only SOLR is supported. Fulltext search is optional, so the SOLR component is not required if docspell is run without fulltext search support.
In order to better understand the following pages, some terms are explained.
An item is roughly your document, only that an item may span multiple files, which are called attachments. An item has meta data associated:
doctypecould be used to group tags like
receiptetc. Usually an item is not tagged with more than one tag of a category.
The users of the application are part of a collective. A collective is a group of users that share access to the same items. The account name is therefore comprised of a collective name and a user name.
All users of a collective are equal; they have same permissions to access all items. The items don't belong to a user, but to the collective.
That means, to identify yourself when signing in, you have to give the
collective name and your user name. By default it is separated by a
/, for example
smith/john. If your user name is the same as
the collective name, you can omit one; so
smith/smith can be
abbreviated to just
By default, all users can see all items of their collective. A folder can be used to implement other visibilities: Every user can create a folder and associate members. It is possible to put items in these folders and docspell shows only items that are either in no specific folder or in a folder where the current user is owner or member.