diff --git a/Dockerfile b/Dockerfile index 686496475..92acc8836 100644 --- a/Dockerfile +++ b/Dockerfile @@ -30,6 +30,7 @@ RUN apt-get update \ && apt-get -y --no-install-recommends install \ build-essential \ curl \ + fonts-liberation \ ghostscript \ gnupg \ icc-profiles-free \ @@ -93,6 +94,7 @@ RUN sudo -HEu paperless python3 manage.py collectstatic --clear --no-input VOLUME ["/usr/src/paperless/data", "/usr/src/paperless/media", "/usr/src/paperless/consume", "/usr/src/paperless/export"] ENTRYPOINT ["/sbin/docker-entrypoint.sh"] +EXPOSE 8000 CMD ["/usr/local/bin/supervisord", "-c", "/etc/supervisord.conf"] LABEL maintainer="Jonas Winkler " diff --git a/README.md b/README.md index 32ff2ab4a..eea41ce05 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ [![Build Status](https://travis-ci.org/jonaswinkler/paperless-ng.svg?branch=master)](https://travis-ci.org/jonaswinkler/paperless-ng) [![Documentation Status](https://readthedocs.org/projects/paperless-ng/badge/?version=latest)](https://paperless-ng.readthedocs.io/en/latest/?badge=latest) +[![Gitter](https://badges.gitter.im/paperless-ng/community.svg)](https://gitter.im/paperless-ng/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Docker Hub Pulls](https://img.shields.io/docker/pulls/jonaswinkler/paperless-ng.svg)](https://hub.docker.com/r/jonaswinkler/paperless-ng) [![Coverage Status](https://coveralls.io/repos/github/jonaswinkler/paperless-ng/badge.svg?branch=master)](https://coveralls.io/github/jonaswinkler/paperless-ng?branch=master) # Paperless-ng -[Paperless](https://github.com/the-paperless-project/paperless) is an application by Daniel Quinn and others that indexes your scanned documents and allows you to easily search for documents and store metadata alongside your documents. +[Paperless](https://github.com/the-paperless-project/paperless) is an application by Daniel Quinn and contributors that indexes your scanned documents and allows you to easily search for documents and store metadata alongside your documents. Paperless-ng is a fork of the original project, adding a new interface and many other changes under the hood. For a detailed list of changes, have a look at the changelog in the documentation. @@ -39,14 +40,13 @@ Here's what you get: * Auto completion suggests relevant words from your documents. * Results are sorted by relevance to your search query. * Highlighting shows you which parts of the document matched the query. + * Searching for similar documents ("More like this") * Email processing: Paperless adds documents from your email accounts. * Configure multiple accounts and filters for each account. * When adding documents from mails, paperless can move these mails to a new folder, mark them as read, flag them or delete them. * Machine learning powered document matching. * Paperless learns from your documents and will be able to automatically assign tags, correspondents and types to documents once you've stored a few documents in paperless. * A task processor that processes documents in parallel and also tells you when something goes wrong. On modern multi core systems, consumption is blazing fast. -* Code cleanup in many, MANY areas. Some of the code from OG paperless was just overly complicated. -* More tests, more stability. If you want to see some screenshots of paperless-ng in action, [some are available in the documentation](https://paperless-ng.readthedocs.io/en/latest/screenshots.html). @@ -54,10 +54,7 @@ For a complete list of changes from paperless, check out the [changelog](https:/ # Roadmap for 1.0 -- **Bulk editing**. Add/remove metadata from multiple documents at once. - - Make the front end nice (except mobile). -- Test coverage at 90%. - Fix whatever bugs I and you find. ## Roadmap for versions beyond 1.0 @@ -66,13 +63,13 @@ These are things that I want to add to paperless eventually. They are sorted by - **More search.** The search backend is incredibly versatile and customizable. Searching is the most important feature of this project and thus, I want to implement things like: - Group and limit search results by correspondent, show “more from this” links in the results. - - Ability to search for “Similar documents” in the search results - **Nested tags**. Organize tags in a hierarchical structure. This will combine the benefits of folders and tags in one coherent system. +- **Localization.** I won't translate paperless into any other languages except English and German, however, I'll add the necessary means so that anyone can translate paperless into their favorite language. - **An interactive consumer** that shows its progress for documents it processes on the web page. - - With live updates ans websockets. This already works on a dev branch, but requires a lot of new dependencies, which I'm not particular happy about. + - With live updates and websockets. This already works on a dev branch, but requires a lot of new dependencies, which I'm not particularly happy about. - Notifications when a document was added with buttons to open the new document right away. - **Arbitrary tag colors**. Allow the selection of any color with a color picker. -- **More file types**. Possibly allow more file types to be processed by paperless, such as office .odt, .doc, .docx documents. +- **More file types**. Possibly allow more file types to be processed by paperless, such as office .odt, .doc and .docx documents. Apart from that, paperless is pretty much feature complete. @@ -80,6 +77,15 @@ Apart from that, paperless is pretty much feature complete. - **GnuPG encrypion.** [Here's a note about encryption in paperless](https://paperless-ng.readthedocs.io/en/latest/administration.html#managing-encryption). The gist of it is that I don't see which attacks this implementation protects against. It gives a false sense of security to users who don't care about how it works. +## Wont-do list. + +These features will probably never make it into paperless, since paperless is meant to be an easy to use set-and-forget solution. + +- **Document versions.** I might consider adding the ability to update a document with a newer version, but that's about it. The kind of documents that get added to paperless usually don't change at all. +- **Workflows.** I don't see a use case for these, yet. +- **Folders.** Tags are superior in just about every way. +- **Apps / extension support.** Again, paperless is meant to be simple. + # Getting started The recommended way to deploy paperless is docker-compose. Don't clone the repository, grab the latest release to get started instead. The dockerfiles archive contains just the docker files which will pull the image from docker hub. The source archive contains everything you need to build the docker image yourself (i.e. if you want to run on Raspberry Pi). @@ -116,7 +122,6 @@ Paperless has been around a while now, and people are starting to build stuff on These projects also exist, but their status and compatibility with paperless-ng is unknown. * [Paperless Desktop](https://github.com/thomasbrueggemann/paperless-desktop): A desktop UI for your Paperless installation. Runs on Mac, Linux, and Windows. -* [ansible-role-paperless](https://github.com/ovv/ansible-role-paperless): An easy way to get Paperless running via Ansible. * [paperless-cli](https://github.com/stgarf/paperless-cli): A golang command line binary to interact with a Paperless instance. # Important Note diff --git a/docker/gunicorn.conf.py b/docker/gunicorn.conf.py index a2f456079..88d881664 100644 --- a/docker/gunicorn.conf.py +++ b/docker/gunicorn.conf.py @@ -1,4 +1,4 @@ -bind = '127.0.0.1:8000' +bind = '[::]:8000' backlog = 2048 workers = 3 worker_class = 'sync' diff --git a/docker/supervisord.conf b/docker/supervisord.conf index ebe0f005d..ff3ed4311 100644 --- a/docker/supervisord.conf +++ b/docker/supervisord.conf @@ -8,7 +8,7 @@ loglevel=info ; log level; default info; others: debug,warn,trace user=root [program:gunicorn] -command=gunicorn -c /usr/src/paperless/gunicorn.conf.py -b 0.0.0.0:8000 paperless.wsgi +command=gunicorn -c /usr/src/paperless/gunicorn.conf.py -b '[::]:8000' paperless.wsgi user=paperless stdout_logfile=/dev/stdout diff --git a/docs/setup.rst b/docs/setup.rst index 4d29ce640..437409194 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -221,8 +221,9 @@ writing. Windows is not and will never be supported. * ``python3-pip``, optionally ``pipenv`` for package installation * ``python3-dev`` + * ``fonts-liberation`` for generating thumbnails for plain text files * ``imagemagick`` >= 6 for PDF conversion - * ``optipng`` for optimising thumbnails + * ``optipng`` for optimizing thumbnails * ``gnupg`` for handling encrypted documents * ``libpoppler-cpp-dev`` for PDF to text conversion * ``libmagic-dev`` for mime type detection @@ -242,8 +243,7 @@ writing. Windows is not and will never be supported. * ``tesseract-ocr`` language packs (``tesseract-ocr-eng``, ``tesseract-ocr-deu``, etc) You will also need ``build-essential``, ``python3-setuptools`` and ``python3-wheel`` - for installing some of the python dependencies. You can remove that - again after installation. + for installing some of the python dependencies. 2. Install ``redis`` >= 5.0 and configure it to start automatically. diff --git a/src-ui/angular.json b/src-ui/angular.json index 2ff1bb3b0..79233eeda 100644 --- a/src-ui/angular.json +++ b/src-ui/angular.json @@ -31,7 +31,10 @@ "styles": [ "src/styles.scss" ], - "scripts": [] + "scripts": [], + "allowedCommonJsDependencies": [ + "ng2-pdf-viewer" + ] }, "configurations": { "production": { @@ -127,4 +130,4 @@ } }, "defaultProject": "paperless-ui" -} \ No newline at end of file +} diff --git a/src-ui/src/app/app.module.ts b/src-ui/src/app/app.module.ts index 37b3a027d..c78dc3cfe 100644 --- a/src-ui/src/app/app.module.ts +++ b/src-ui/src/app/app.module.ts @@ -26,12 +26,13 @@ import { ResultHighlightComponent } from './components/search/result-highlight/r import { PageHeaderComponent } from './components/common/page-header/page-header.component'; import { AppFrameComponent } from './components/app-frame/app-frame.component'; import { ToastsComponent } from './components/common/toasts/toasts.component'; -import { FilterEditorComponent } from './components/filter-editor/filter-editor.component'; -import { FilterDropdownComponent } from './components/filter-editor/filter-dropdown/filter-dropdown.component'; -import { FilterDropdownButtonComponent } from './components/filter-editor/filter-dropdown/filter-dropdown-button/filter-dropdown-button.component'; -import { FilterDropdownDateComponent } from './components/filter-editor/filter-dropdown-date/filter-dropdown-date.component'; +import { FilterEditorComponent } from './components/document-list/filter-editor/filter-editor.component'; +import { FilterableDropdownComponent } from './components/common/filterable-dropdown/filterable-dropdown.component'; +import { ToggleableDropdownButtonComponent } from './components/common/filterable-dropdown/toggleable-dropdown-button/toggleable-dropdown-button.component'; +import { DateDropdownComponent } from './components/common/date-dropdown/date-dropdown.component'; import { DocumentCardLargeComponent } from './components/document-list/document-card-large/document-card-large.component'; import { DocumentCardSmallComponent } from './components/document-list/document-card-small/document-card-small.component'; +import { BulkEditorComponent } from './components/document-list/bulk-editor/bulk-editor.component'; import { NgxFileDropModule } from 'ngx-file-drop'; import { TextComponent } from './components/common/input/text/text.component'; import { SelectComponent } from './components/common/input/select/select.component'; @@ -54,8 +55,8 @@ import { FileSizePipe } from './pipes/file-size.pipe'; import { FilterPipe } from './pipes/filter.pipe'; import { DocumentTitlePipe } from './pipes/document-title.pipe'; import { MetadataCollapseComponent } from './components/document-detail/metadata-collapse/metadata-collapse.component'; -import { NgSelectModule } from '@ng-select/ng-select'; import { SelectDialogComponent } from './components/common/select-dialog/select-dialog.component'; +import { NgSelectModule } from '@ng-select/ng-select'; @NgModule({ declarations: [ @@ -80,11 +81,12 @@ import { SelectDialogComponent } from './components/common/select-dialog/select- AppFrameComponent, ToastsComponent, FilterEditorComponent, - FilterDropdownComponent, - FilterDropdownButtonComponent, - FilterDropdownDateComponent, + FilterableDropdownComponent, + ToggleableDropdownButtonComponent, + DateDropdownComponent, DocumentCardLargeComponent, DocumentCardSmallComponent, + BulkEditorComponent, TextComponent, SelectComponent, CheckComponent, diff --git a/src-ui/src/app/components/app-frame/app-frame.component.html b/src-ui/src/app/components/app-frame/app-frame.component.html index 5fe42fc40..d191ec0de 100644 --- a/src-ui/src/app/components/app-frame/app-frame.component.html +++ b/src-ui/src/app/components/app-frame/app-frame.component.html @@ -1,8 +1,8 @@