A community-supported supercharged version of paperless: scan, index and archive all your physical documents
Find a file
dependabot[bot] 77bebc861d
Chore(deps-dev): Bump the frontend-eslint-dependencies group (#7827)
Bumps the frontend-eslint-dependencies group in /src-ui with 4 updates: [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin), [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/parser), [@typescript-eslint/utils](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/utils) and [eslint](https://github.com/eslint/eslint).


Updates `@typescript-eslint/eslint-plugin` from 8.3.0 to 8.8.0
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v8.8.0/packages/eslint-plugin)

Updates `@typescript-eslint/parser` from 8.3.0 to 8.8.0
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/parser/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v8.8.0/packages/parser)

Updates `@typescript-eslint/utils` from 8.3.0 to 8.8.0
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/utils/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v8.8.0/packages/utils)

Updates `eslint` from 9.9.1 to 9.11.1
- [Release notes](https://github.com/eslint/eslint/releases)
- [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md)
- [Commits](https://github.com/eslint/eslint/compare/v9.9.1...v9.11.1)

---
updated-dependencies:
- dependency-name: "@typescript-eslint/eslint-plugin"
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: frontend-eslint-dependencies
- dependency-name: "@typescript-eslint/parser"
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: frontend-eslint-dependencies
- dependency-name: "@typescript-eslint/utils"
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: frontend-eslint-dependencies
- dependency-name: eslint
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: frontend-eslint-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-10-01 21:20:53 +00:00
.devcontainer Development: Add VS Code Devcontainer Configuration (#7041) 2024-06-27 15:13:55 -07:00
.github Chore: Drop Python 3.9 support (#7774) 2024-09-26 12:22:24 -07:00
docker Enhancement: use apt only when needed docker-entrypoint.sh (#7756) 2024-09-23 23:46:03 -07:00
docs Documentation: Mention the Redis licensing and its forks (#7817) 2024-10-01 01:58:07 +00:00
resources New -ngx logo 2022 2022-02-26 20:14:24 -08:00
scripts Enhancement: include owner username in post-consumption variables (#7270) 2024-07-16 15:23:29 -07:00
src Chore: Upgrades OCRMyPDF to v16 (#7815) 2024-10-01 02:53:44 +00:00
src-ui Chore(deps-dev): Bump the frontend-eslint-dependencies group (#7827) 2024-10-01 21:20:53 +00:00
.codecov.yml Chore: Add codecov bundle analysis (#7673) 2024-09-10 17:55:12 -07:00
.codespellrc Chore(deps-dev): Bump the development group across 1 directory with 2 updates (#6851) 2024-05-29 07:04:01 +00:00
.dockerignore Unlocks all things which were locked due to ARMv7, etc 2023-09-08 11:21:43 -07:00
.editorconfig Updates some deps, skipping scipy 2022-08-10 08:45:49 -07:00
.env Chore: Remove unneeded .env entry, revert crowdin action rm, reduce frequency 2023-12-02 08:24:17 -08:00
.gitignore Development: Add VS Code Devcontainer Configuration (#7041) 2024-06-27 15:13:55 -07:00
.hadolint.yml Squashed commit of the following: 2022-07-28 15:36:24 -07:00
.pre-commit-config.yaml Chore: Upgrades OCRMyPDF to v16 (#7815) 2024-10-01 02:53:44 +00:00
.prettierrc Documentation: Structure backup section more clearly (#4559) 2023-11-16 00:26:52 +00:00
.python-version Chore: Drop Python 3.9 support (#7774) 2024-09-26 12:22:24 -07:00
.ruff.toml Chore: Drop Python 3.9 support (#7774) 2024-09-26 12:22:24 -07:00
CODE_OF_CONDUCT.md Chore(deps-dev): Bump the development group across 1 directory with 2 updates (#6851) 2024-05-29 07:04:01 +00:00
CODEOWNERS Changes the Dockerfile to use pipenv and the releases to use pipenv, removing the need for a requirements.txt 2022-07-30 13:41:08 -07:00
CONTRIBUTING.md Chore: Drop Python 3.9 support (#7774) 2024-09-26 12:22:24 -07:00
crowdin.yml Chore: Implement crowdin GHA (#4706) 2023-12-01 17:44:33 -08:00
Dockerfile Upgrades the Docker image to use Python 3.12 (#7796) 2024-09-28 18:42:55 +00:00
gunicorn.conf.py Chore(deps): Bump all allowed backend packages (#6562) 2024-05-04 13:26:15 -07:00
install-paperless-ngx.sh Fix: add timezone fallback to install script (#6336) 2024-04-08 17:45:43 -07:00
LICENSE Initial commit 2015-12-20 12:54:28 +00:00
mkdocs.yml Documentation: support use system preferences for light/dark mode (#7586) 2024-08-31 14:36:29 -07:00
paperless-ngx.code-workspace Recommends some extensions and sets the default interpreter path (#6884) 2024-06-02 03:34:40 +00:00
paperless.conf.example Feature: Enhanced backend custom field search API (#7589) 2024-09-23 23:33:49 -07:00
Pipfile Chore: Upgrades OCRMyPDF to v16 (#7815) 2024-10-01 02:53:44 +00:00
Pipfile.lock Chore: Upgrades OCRMyPDF to v16 (#7815) 2024-10-01 02:53:44 +00:00
README.md Documentation: correct DO logo URL 2024-08-07 12:19:50 -07:00
SECURITY.md Create SECURITY.md 2024-02-15 23:38:33 -08:00

ci Crowdin Documentation Status codecov Chat on Matrix demo

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 is the official successor to the original Paperless & Paperless-ng projects and is designed to distribute the responsibility of advancing and supporting the project among a team of people. Consider joining us!

Thanks to the generous folks at DigitalOcean, a demo is available at demo.paperless-ngx.com using login demo / demo. Note: demo content is reset frequently and confidential information should not be uploaded.

This project is supported by:

Features

A full list of features and screenshots are available in the documentation.

Getting started

The easiest way to deploy paperless is docker compose. The files in the /docker/compose directory 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 -c "$(curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/install-paperless-ngx.sh)"

More details and step-by-step guides for alternative installation methods can be found in the documentation.

Migrating from Paperless-ng is easy, just drop in the new docker image! See the documentation on migrating for more details.

Documentation

The documentation for Paperless-ngx is available at 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 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. If you would like to contribute to the project on an ongoing basis there are multiple teams (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.

Feature Requests

Feature requests can be submitted via GitHub Discussions, you can search for existing ideas, add your own and vote for the ones you care about.

Bugs

For bugs please open an issue or start a discussion if you have questions.

Related Projects

Please see the wiki for a user-maintained list of related 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.