mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2025-04-02 13:45:10 -05:00
110 lines
7.7 KiB
Markdown
110 lines
7.7 KiB
Markdown
[](https://github.com/paperless-ngx/paperless-ngx/actions)
|
|
[](https://crowdin.com/project/paperless-ngx)
|
|
[](https://docs.paperless-ngx.com)
|
|
[](https://codecov.io/gh/paperless-ngx/paperless-ngx)
|
|
[](https://matrix.to/#/%23paperlessngx%3Amatrix.org)
|
|
[](https://demo.paperless-ngx.com)
|
|
|
|
<p align="center">
|
|
<img src="https://github.com/paperless-ngx/paperless-ngx/raw/main/resources/logo/web/png/Black%20logo%20-%20no%20background.png#gh-light-mode-only" width="50%" />
|
|
<img src="https://github.com/paperless-ngx/paperless-ngx/raw/main/resources/logo/web/png/White%20logo%20-%20no%20background.png#gh-dark-mode-only" width="50%" />
|
|
</p>
|
|
|
|
<!-- omit in toc -->
|
|
|
|
# Paperless-ngx
|
|
|
|
Paperless-ngx is a document management system that transforms your physical documents into a searchable online archive so you can keep, well, _less paper_.
|
|
|
|
Paperless-ngx forked from [paperless-ng](https://github.com/jonaswinkler/paperless-ng) to continue the great work and distribute responsibility of supporting and advancing the project among a team of people. [Consider joining us!](#community-support) Discussion of this transition can be found in issues
|
|
[#1599](https://github.com/jonaswinkler/paperless-ng/issues/1599) and [#1632](https://github.com/jonaswinkler/paperless-ng/issues/1632).
|
|
|
|
A demo is available at [demo.paperless-ngx.com](https://demo.paperless-ngx.com) using login `demo` / `demo`. _Note: demo content is reset frequently and confidential information should not be uploaded._
|
|
|
|
- [Features](#features)
|
|
- [Getting started](#getting-started)
|
|
- [Contributing](#contributing)
|
|
- [Community Support](#community-support)
|
|
- [Translation](#translation)
|
|
- [Feature Requests](#feature-requests)
|
|
- [Bugs](#bugs)
|
|
- [Affiliated Projects](#affiliated-projects)
|
|
- [Important Note](#important-note)
|
|
|
|
# Features
|
|
|
|
|
|
|
|
|
|
- Organize and index your scanned documents with tags, correspondents, types, and more.
|
|
- Performs OCR on your documents, adds selectable text to image only documents and adds tags, correspondents and document types to your documents.
|
|
- Supports PDF documents, images, plain text files, and Office documents (Word, Excel, Powerpoint, and LibreOffice equivalents).
|
|
- Office document support is optional and provided by Apache Tika (see [configuration](https://docs.paperless-ngx.com/configuration/#tika))
|
|
- Paperless stores your documents plain on disk. Filenames and folders are managed by paperless and their format can be configured freely.
|
|
- Single page application front end.
|
|
- Includes a dashboard that shows basic statistics and has document upload.
|
|
- Filtering by tags, correspondents, types, and more.
|
|
- Customizable views can be saved and displayed on the dashboard.
|
|
- Full text search helps you find what you need.
|
|
- 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 mail, paperless can move these mail to a new folder, mark them as read, flag them as important or delete them.
|
|
- Machine learning powered document matching.
|
|
- Paperless-ngx 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.
|
|
- Optimized for multi core systems: Paperless-ngx consumes multiple documents in parallel.
|
|
- The integrated sanity checker makes sure that your document archive is in good health.
|
|
- [More screenshots are available in the documentation](https://docs.paperless-ngx.com/#screenshots).
|
|
|
|
# Getting started
|
|
|
|
The easiest way to deploy paperless is docker-compose. The files in the [`/docker/compose` directory](https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose) are configured to pull the image from GitHub Packages.
|
|
|
|
If you'd like to jump right in, you can configure a docker-compose environment with our install script:
|
|
|
|
```bash
|
|
bash -c "$(curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/install-paperless-ngx.sh)"
|
|
```
|
|
|
|
Alternatively, you can install the dependencies and setup apache and a database server yourself. The [documentation](https://docs.paperless-ngx.com/setup/#installation) has a step by step guide on how to do it.
|
|
|
|
Migrating from Paperless-ng is easy, just drop in the new docker image! See the [documentation on migrating](https://docs.paperless-ngx.com/setup/#migrating-to-paperless-ngx) for more details.
|
|
|
|
<!-- omit in toc -->
|
|
|
|
### Documentation
|
|
|
|
The documentation for Paperless-ngx is available at [https://docs.paperless-ngx.com](https://docs.paperless-ngx.com/).
|
|
|
|
# Contributing
|
|
|
|
If you feel like contributing to the project, please do! Bug fixes, enhancements, visual fixes etc. are always welcome. If you want to implement something big: Please start a discussion about that! The [documentation](https://docs.paperless-ngx.com/development/) has some basic information on how to get started.
|
|
|
|
## Community Support
|
|
|
|
People interested in continuing the work on paperless-ngx are encouraged to reach out here on github and in the [Matrix Room](https://matrix.to/#/#paperless:matrix.org). If you would like to contribute to the project on an ongoing basis there are multiple [teams](https://github.com/orgs/paperless-ngx/people) (frontend, ci/cd, etc) that could use your help so please reach out!
|
|
|
|
## Translation
|
|
|
|
Paperless-ngx is available in many languages that are coordinated on Crowdin. If you want to help out by translating paperless-ngx into your language, please head over to https://crwd.in/paperless-ngx, and thank you! More details can be found in [CONTRIBUTING.md](https://github.com/paperless-ngx/paperless-ngx/blob/main/CONTRIBUTING.md#translating-paperless-ngx).
|
|
|
|
## Feature Requests
|
|
|
|
Feature requests can be submitted via [GitHub Discussions](https://github.com/paperless-ngx/paperless-ngx/discussions/categories/feature-requests), you can search for existing ideas, add your own and vote for the ones you care about.
|
|
|
|
## Bugs
|
|
|
|
For bugs please [open an issue](https://github.com/paperless-ngx/paperless-ngx/issues) or [start a discussion](https://github.com/paperless-ngx/paperless-ngx/discussions) if you have questions.
|
|
|
|
# Affiliated Projects
|
|
|
|
Please see [the wiki](https://github.com/paperless-ngx/paperless-ngx/wiki/Affiliated-Projects) for a user-maintained list of affiliated projects and software that is compatible with Paperless-ngx.
|
|
|
|
# Important Note
|
|
|
|
> Document scanners are typically used to scan sensitive documents like your social insurance number, tax records, invoices, etc. **Paperless-ngx should never be run on an untrusted host** because information is stored in clear text without encryption. No guarantees are made regarding security (but we do try!) and you use the app at your own risk.
|
|
> **The safest way to run Paperless-ngx is on a local server in your own home with backups in place**.
|