{"id":13424717,"url":"https://github.com/eikek/docspell","last_synced_at":"2026-04-12T11:11:26.780Z","repository":{"id":37034171,"uuid":"197263888","full_name":"eikek/docspell","owner":"eikek","description":"Assist in organizing your piles of documents, resulting from scanners, e-mails and other sources with miminal effort.","archived":false,"fork":false,"pushed_at":"2025-05-05T21:59:17.000Z","size":141657,"stargazers_count":1792,"open_issues_count":215,"forks_count":140,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-05-05T22:41:16.352Z","etag":null,"topics":["dms","docspell","document","document-management","document-management-system","edms","elm","nlp","ocr","pdf","personal-document-system","scala","self-hosted","spa","stanford-corenlp","webapp"],"latest_commit_sha":null,"homepage":"https://docspell.org","language":"Elm","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eikek.png","metadata":{"files":{"readme":"README.md","changelog":"Changelog.md","contributing":"Contributing.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-07-16T20:34:57.000Z","updated_at":"2025-05-05T04:21:07.000Z","dependencies_parsed_at":"2023-09-25T08:09:23.371Z","dependency_job_id":"6b6311c9-54f0-4891-b8fd-6f0fa6f711ab","html_url":"https://github.com/eikek/docspell","commit_stats":{"total_commits":3546,"total_committers":47,"mean_commits":75.44680851063829,"dds":0.4393683023124647,"last_synced_commit":"af4286d115e4b23f3b50acbaee9590b6c254da06"},"previous_names":[],"tags_count":50,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eikek%2Fdocspell","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eikek%2Fdocspell/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eikek%2Fdocspell/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eikek%2Fdocspell/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eikek","download_url":"https://codeload.github.com/eikek/docspell/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254092788,"owners_count":22013290,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dms","docspell","document","document-management","document-management-system","edms","elm","nlp","ocr","pdf","personal-document-system","scala","self-hosted","spa","stanford-corenlp","webapp"],"created_at":"2024-07-31T00:00:58.258Z","updated_at":"2026-02-11T02:58:50.870Z","avatar_url":"https://github.com/eikek.png","language":"Elm","readme":"\u003cimg align=\"right\" src=\"./artwork/logo-only.svg\" height=\"150px\" style=\"padding-left: 20px\"/\u003e\n\n[![Scala Steward badge](https://img.shields.io/badge/Scala_Steward-helping-blue.svg?style=for-the-badge\u0026logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=)](https://scala-steward.org)\n[![License](https://img.shields.io/github/license/eikek/docspell.svg?style=for-the-badge\u0026color=steelblue)](https://github.com/eikek/docspell/blob/master/LICENSE.txt)\n[![Docker Pulls](https://img.shields.io/docker/pulls/docspell/restserver?color=steelblue\u0026style=for-the-badge\u0026logo=docker)](https://hub.docker.com/u/docspell)\n[![Gitter chat](https://img.shields.io/gitter/room/eikek/docspell?style=for-the-badge\u0026color=steelblue\u0026logo=gitter)](https://gitter.im/eikek/docspell)\n\n# Docspell - Document Management System (DMS)\n\nDocspell is a personal document organizer. Or sometimes called a\n\"Document Management System\" (DMS). You'll need a scanner to convert\nyour papers into files. Docspell can then assist in organizing the\nresulting mess :wink:. It can unify your files from scanners, emails\nand other sources. It is targeted for home use, i.e. families,\nhouseholds and also for smaller groups/companies.\n\nYou can associate tags, set correspondends and lots of other\npredefined and custom metadata. If your documents are associated with\nsuch meta data, you can quickly find them later using the search\nfeature. But adding this manually is a tedious task. Docspell can help\nby suggesting correspondents, guessing tags or finding dates using\nmachine learning. It can learn metadata from existing documents and\nfind things using NLP. This makes adding metadata to your documents a\nlot easier. For machine learning, it relies on the free (GPL)\n[Stanford Core NLP library](https://github.com/stanfordnlp/CoreNLP).\n\nDocspell also runs OCR (if needed) on your documents, can provide\nfulltext search and has great e-mail integration. Everything is\naccessible via a REST/HTTP api. A mobile friendly SPA web application\nis the default user interface. An [Android\napp](https://github.com/docspell/android-client) exists for\nconveniently uploading files from your phone/tablet and a\n[cli](https://github.com/docspell/dsc). The [feature\noverview](https://docspell.org/#feature-selection) lists some more\npoints.\n\n\n## Impressions\n\nCheckout the short demo videos (\u003c1min), present on the [project\npage](https://docspell.org/#demos). Here are some screenshots:\n\n![screenshot-1](website/site/content/docs/webapp/dashboards-01_dark.png)\n![screenshot-2](website/site/content/docs/webapp/docspell-curate-1_dark.png)\n![screenshot-3](website/site/content/docs/webapp/custom-fields-03_dark.png)\n![screenshot-4](website/site/content/docs/webapp/multiedit-04_dark.png)\n![screenshot-5](website/site/content/docs/webapp/mail-item-1.png)\n![screenshot-7](website/site/static/screenshots/mobile/Screenshot_2021-02-14-04-small.jpg)\n![screenshot-8](website/site/static/screenshots/mobile/Screenshot_2021-02-14-09-small.jpg)\n\n## Try it\n\nDocspell consists of several components. The probably quickest way to\nget started is to use the docker setup as described in the [get started\npage](https://docspell.org/#get-started). This is only three commands\naway:\n\n``` shell\ngit clone https://github.com/docspell/docker docspell-docker\ncd docspell-docker/docker-compose\ndocker-compose up -d\n```\n\nThen go to `http://localhost:7880`, sign up and login. Use the same\nname for collective and user for now. More on that can be found\n[here](https://docspell.org/docs/intro/).\n\nOther ways are documented\n[here](https://docspell.org/docs/install/quickstart/):\n\n- Install the [provided](https://github.com/eikek/docspell/releases)\n  `deb` file at your debian based system.\n- Download [provided](https://github.com/eikek/docspell/releases) zip\n  file and run the script in `bin/`, as [described\n  here](https://docspell.org/docs/install/installing/#download-unpack-run).\n- Using the [nix](https://nixos.org/nix) package manager as [described\n  here](https://docspell.org/docs/install/installing/#nix). A NixOS\n  module is available, too.\n- Use the [Helm Chart](https://github.com/docspell/docker/tree/main/charts/docspell).\n\n\n## Documentation\n\nThe [project page](https://docspell.org) has lots of information on\nhow to [use and setup](https://docspell.org/docs) docspell.\n\n\n## Contributions/Support\n\nFeedback and other contributions are very welcome! There is a [gitter\nroom](https://gitter.im/eikek/docspell) for chatting and questions.\nYou can also [open an\nissue](https://github.com/eikek/docspell/issues/new) for questions,\nproblems and other feedback; or make a mail to `info [at]\ndocspell.org`. I'll try to answer in time. You may want to check\n[Contributing.md](Contributing.md) for some starting points, too.\n\nIf you find this project any useful and want to support it via other\nmeans, giving a :star: is always encouraging and much appreciated. You\ncan also support activity by donating via\n[liberapay](https://liberapay.com/eikek/) or\n[paypal](https://paypal.me/eikek0).\n\nThank you so much!\n\n## Tech Stack\n\n**Backend**\n\nThe servers is written in Scala in a pure functional style, based on\nlibraries from the [typelevel](https://typelevel.org) stack: Cats,\nFS2, Doobie, Http4s, Circe and Pureconfig.\n\nThere are more libraries and technologies used, of course. Docspell is\nonly a orchestration of great tools and libs. One important is the\n[Stanford-NLP](https://nlp.stanford.edu/software/), that provides the\nML features. Furthermore, file processing relies on external tools\nlike tesseract, unoconv and ocrmypdf. All dependencies can be looked\nup in `project/Dependencies.scala`.\n\n\n**Frontend**\n\nThe web frontend is a SPA written in [Elm](https://elm-lang.org). The\nUI framework in use is [tailwind](https://tailwindcss.com).\n\n\n## License\n\nDocspell is free software, distributed under the [AGPLv3 or\nlater](https://spdx.org/licenses/AGPL-3.0-or-later.html).\n","funding_links":["https://liberapay.com/eikek/","https://paypal.me/eikek0"],"categories":["Elm","Scala","Apps","webapp","nlp","Table of Contents"],"sub_categories":["KnowledgeBase","Document Management"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feikek%2Fdocspell","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feikek%2Fdocspell","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feikek%2Fdocspell/lists"}