Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(role): add docspell #175

Merged
merged 3 commits into from
Nov 19, 2022
Merged

feat(role): add docspell #175

merged 3 commits into from
Nov 19, 2022

Conversation

JigSawFr
Copy link
Collaborator

Description

Docspell is a personal document organizer. Or sometimes called a "Document Management System" (DMS). You'll need a scanner to convert your papers into files. Docspell can then assist in organizing the resulting mess 😉. It can unify your files from scanners, emails and other sources. It is targeted for home use, i.e. families, households and also for smaller groups/companies.

You can associate tags, set correspondends and lots of other predefined and custom metadata. If your documents are associated with such meta data, you can quickly find them later using the search feature. But adding this manually is a tedious task. Docspell can help by suggesting correspondents, guessing tags or finding dates using machine learning. It can learn metadata from existing documents and find things using NLP. This makes adding metadata to your documents a lot easier. For machine learning, it relies on the free (GPL) Stanford Core NLP library.

Docspell also runs OCR (if needed) on your documents, can provide fulltext search and has great e-mail integration. Everything is accessible via a REST/HTTP api. A mobile friendly SPA web application is the default user interface. An Android app exists for conveniently uploading files from your phone/tablet and a cli. The feature overview lists some more points.

How Has This Been Tested?

  • App is working as expected. (Container is alive and answering to requests)
  • App use a dedicated folder in /opt directory.
  • App secured by Authelia SSO authentication system.
  • A subdomain is correctly created for the web-ui. (via Cloudflare)
  • Custom TimeZone is set to the container and application.
  • Custom UID/GID is set to the container to run under Saltbox user.
  • Healthcheck is added to the container.
  • Add a custom sub-role: Apache Solr

@JigSawFr JigSawFr self-assigned this Nov 13, 2022
@JigSawFr JigSawFr requested a review from owine November 19, 2022 14:47
@JigSawFr JigSawFr marked this pull request as ready for review November 19, 2022 14:49
@JigSawFr JigSawFr merged commit 816e6f5 into saltyorg:master Nov 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants