Docspell
Simple document organizer
Docspell assists in organizing your piles of digital documents, resulting from scanners, e-mails and other sources with minimal effort.
Photo by JF Martin
Docspell assists in organizing your piles of digital documents, resulting from scanners, e-mails and other sources with minimal effort.
Presents the basic idea: maintain an address book and let docspell find matches for new uploaded documents and attach them automatically.
Shows basic navigation through documents using tags and tag categories.
Each account (a collective) can have multiple users that share the same files. For example, everyone in your family can work with your files while using their own account with their own settings.
Text is extracted from all files. For scanned documents/images, OCR is used by utilising tesseract. The text is analysed and is available for full-text search.
The extracted text is analyzed using ML algorithms to find properties that can be annotated to your documents automatically.
Docspell can read many file types. ZIP and EML (e-mail file format) files are extracted and their contents imported.
All files are converted to PDF. Don't worry about the originals. Original files are stored, too and can be downloaded untouched. When creating PDFs from image data (often returned from scanners), the resulting PDF contains the extracted text and is searchable.
The extracted text of all files and some properties, like names and notes, are available for full-text search. Full-text search can also be used to further constrain the results of the search-menu where you can search by tags, correspondent, etc.
Users can define SMTP settings in the app and are then able to send items out via E-Mail. This is often useful to share with other people. There is e-mail-address completion from your address book, of course.
Users can define IMAP settings so that docspell can import their e-mails. This can be done periodically based on a schedule. Imported mails can be moved away into another folder or deleted.
Users can be notified by e-mail, Matrix or Gotify with documents resulting from a query that is executed periodically. Notifications can also be configured for specific events.
Docspell consists of several components. The easiest way to get started is probably to use docker and docker-compose.
$ git clone https://github.com/docspell/docker docspell-docker
docker-compose directory:$ cd docspell-docker/docker-compose
docker-compose up:$ docker compose up -d
./docs/<collective-name> (the name you
chose for the collective at registration) and place files in there
for importing them.The docker-compose.yml file defines some environment variables to
configure docspell. You can modify them as needed.