paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-10-30 03:56:23 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update docs, yml to -ngx

Browse Source
This commit is contained in:
Quinn Casey
2022-03-01 14:09:09 -08:00
parent fe0f515c5c
commit 16a4c15adb
9 changed files with 24 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@@ -29,7 +29,7 @@ To test your code, execute `pytest` in the src/ directory. This also generates a
## More info: ## More info:
... is available in the documentation. https://paperless-ng.readthedocs.io/en/latest/extending.html ... is available in the documentation. https://paperless-ngx.readthedocs.io/en/latest/extending.html
# Merging PRs # Merging PRs

4
README.md
View File

@@ -54,7 +54,7 @@ A demo is available at [demo.paperless-ngx.com](https://demo.paperless-ngx.com)
* 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. * 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. * 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. * 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-ng consumes multiple documents in parallel. * 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. * The integrated sanity checker makes sure that your document archive is in good health.
* [More screenshots are available in the documentation](https://paperless-ngx.readthedocs.io/en/latest/screenshots.html). * [More screenshots are available in the documentation](https://paperless-ngx.readthedocs.io/en/latest/screenshots.html).
@@ -65,7 +65,7 @@ The easiest way to deploy paperless is docker-compose. The files in the [`/docke
If you'd like to jump right in, you can configure a docker-compose environment with our install script: If you'd like to jump right in, you can configure a docker-compose environment with our install script:
```bash ```bash
bash -c "$(curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/master/install-paperless-ng.sh)" bash -c "$(curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/master/install-paperless-ngx.sh)"
``` ```
Alternatively, you can install the dependencies and setup apache and a database server yourself. The [documentation](https://paperless-ngx.readthedocs.io/en/latest/setup.html#installation) has a step by step guide on how to do it. Alternatively, you can install the dependencies and setup apache and a database server yourself. The [documentation](https://paperless-ngx.readthedocs.io/en/latest/setup.html#installation) has a step by step guide on how to do it.

2
docker/docker-entrypoint.sh
View File

@@ -74,7 +74,7 @@ install_languages() {
done done
} }
echo "Paperless-ng docker container starting..." echo "Paperless-ngx docker container starting..."
# Install additional languages if specified # Install additional languages if specified
if [[ ! -z "$PAPERLESS_OCR_LANGUAGES" ]]; then if [[ ! -z "$PAPERLESS_OCR_LANGUAGES" ]]; then

2
docs/advanced_usage.rst
View File

@@ -57,7 +57,7 @@ automatically tagged with the appropriate data.
Automatic matching Automatic matching
================== ==================
Paperless-ng comes with a new matching algorithm called *Auto*. This matching Paperless-ngx comes with a new matching algorithm called *Auto*. This matching
algorithm tries to assign tags, correspondents, and document types to your algorithm tries to assign tags, correspondents, and document types to your
documents based on how you have already assigned these on existing documents. It documents based on how you have already assigned these on existing documents. It
uses a neural network under the hood. uses a neural network under the hood.

2
docs/faq.rst
View File

@@ -5,7 +5,7 @@ Frequently asked questions
**Q:** *What's the general plan for Paperless-ng?* **Q:** *What's the general plan for Paperless-ng?*
**A:** Paperless-ng is already almost feature-complete. This project will remain **A:** Paperless-ngx is already almost feature-complete. This project will remain
as simple as it is right now. It will see improvements to features that are already there. as simple as it is right now. It will see improvements to features that are already there.
If you need advanced features such as document versions, If you need advanced features such as document versions,
workflows or multi-user with customizable access to individual files, this is workflows or multi-user with customizable access to individual files, this is

20
docs/index.rst
View File

@@ -22,19 +22,21 @@ finding stuff again. I feed documents right from the post box into the scanner
and then shred them. Perhaps you might find it useful too. and then shred them. Perhaps you might find it useful too.
Paperless-ng Paperless-ngx
============ =============
Paperless-ng is a fork of the original paperless project. It changes many Paperless-ngx is a document management system that transforms your physical
things both on the surface and under the hood. Paperless-ng was created documents into a searchable online archive so you can keep, well, *less paper*.
because I feel that these changes are too big to be pushed into the main
repository right away. Paperless-ngx forked from paperless-ng to continue the great work and
distribute responsibility of supporting and advancing the project among a team
of people.
NG stands for both Angular (the framework used for the NG stands for both Angular (the framework used for the
Frontend) and next-gen. Publishing this project under a different name also Frontend) and next-gen. Publishing this project under a different name also
avoids confusion between paperless and paperless-ngx. avoids confusion between paperless and paperless-ngx.
If you want to learn about what's different in paperless-ngx, check out these If you want to learn about what's different in paperless-ng from Paperless, check out these
resources in the documentation: resources in the documentation:
* :ref:`Some screenshots <screenshots>` of the new UI are available. * :ref:`Some screenshots <screenshots>` of the new UI are available.
@@ -53,10 +55,6 @@ resources in the documentation:
* The :ref:`changelog <paperless_changelog>` contains a detailed list of all changes * The :ref:`changelog <paperless_changelog>` contains a detailed list of all changes
in paperless-ngx. in paperless-ngx.
It would be great if this project could eventually merge back into the main
repository, but it needs a lot more work before that can happen.
Contents Contents
======== ========

2
docs/scanners.rst
View File

@@ -103,7 +103,7 @@ You can use your phone to "scan" documents. The regular camera app will work, bu
| `OCR Scanner - QuickScan`_ | iOS | no | no | no | no | yes | `holzhannes`_ | | `OCR Scanner - QuickScan`_ | iOS | no | no | no | no | yes | `holzhannes`_ |
+-----------------------------+----------------+-----+-----+-----+-------+--------+------------------+ +-----------------------------+----------------+-----+-----+-----+-------+--------+------------------+
On Android, you can use these applications in combination with one of the :ref:`Paperless-ng compatible apps <usage-mobile_upload>` to "Share" the documents produced by these scanner apps with paperless. On iOS, you can share the scanned documents via iOS-Sharing to other mail, WebDav or FTP apps. On Android, you can use these applications in combination with one of the :ref:`Paperless-ngx compatible apps <usage-mobile_upload>` to "Share" the documents produced by these scanner apps with paperless. On iOS, you can share the scanned documents via iOS-Sharing to other mail, WebDav or FTP apps.
.. _Office Lens: https://play.google.com/store/apps/details?id=com.microsoft.office.officelens .. _Office Lens: https://play.google.com/store/apps/details?id=com.microsoft.office.officelens
.. _Genius Scan: https://play.google.com/store/apps/details?id=com.thegrizzlylabs.geniusscan.free .. _Genius Scan: https://play.google.com/store/apps/details?id=com.thegrizzlylabs.geniusscan.free

14
docs/setup.rst
View File

@@ -3,8 +3,8 @@
Setup Setup
***** *****
Overview of Paperless-ng Overview of Paperless-ngx
######################## #########################
Compared to paperless, paperless-ngx works a little different under the hood and has Compared to paperless, paperless-ngx works a little different under the hood and has
more moving parts that work together. While this increases the complexity of more moving parts that work together. While this increases the complexity of
@@ -110,7 +110,7 @@ performs all the steps described in :ref:`setup-docker_hub` automatically.
.. code:: shell-session .. code:: shell-session
$ bash -c "$(curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/master/install-paperless-ng.sh)" $ bash -c "$(curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/master/install-paperless-ngx.sh)"
.. _setup-docker_hub: .. _setup-docker_hub:
@@ -511,7 +511,7 @@ Migration to paperless-ngx is then performed in a few simple steps:
.. caution:: .. caution::
Paperless-ng includes a ``.env`` file. This will set the Paperless-ngx includes a ``.env`` file. This will set the
project name for docker compose to ``paperless``, which will also define the name project name for docker compose to ``paperless``, which will also define the name
of the volumes by paperless-ngx. However, if you experience that paperless-ngx of the volumes by paperless-ngx. However, if you experience that paperless-ngx
is not using your old paperless volumes, verify the names of your volumes with is not using your old paperless volumes, verify the names of your volumes with
@@ -637,11 +637,11 @@ management commands as below.
Moving back to paperless Moving back to paperless
======================== ========================
Lets say you migrated to Paperless-ng and used it for a while, but decided that Lets say you migrated to Paperless-ngx and used it for a while, but decided that
you don't like it and want to move back (If you do, send me a mail about what you don't like it and want to move back (If you do, send me a mail about what
part you didn't like!), you can totally do that with a few simple steps. part you didn't like!), you can totally do that with a few simple steps.
Paperless-ng modified the database schema slightly, however, these changes can Paperless-ngx modified the database schema slightly, however, these changes can
be reverted while keeping your current data, so that your current data will be reverted while keeping your current data, so that your current data will
be compatible with original Paperless. be compatible with original Paperless.
@@ -659,7 +659,7 @@ Or without docker:
$ cd /path/to/paperless/src $ cd /path/to/paperless/src
$ python3 manage.py migrate documents 0023 $ python3 manage.py migrate documents 0023
After that, you need to clear your cookies (Paperless-ng comes with updated After that, you need to clear your cookies (Paperless-ngx comes with updated
dependencies that do cookie-processing differently) and probably your cache dependencies that do cookie-processing differently) and probably your cache
as well. as well.

2
paperless.conf.example
View File

@@ -1,5 +1,5 @@
# Have a look at the docs for documentation. # Have a look at the docs for documentation.
# https://paperless-ng.readthedocs.io/en/latest/configuration.html # https://paperless-ngx.readthedocs.io/en/latest/configuration.html
# Debug. Only enable this for development. # Debug. Only enable this for development.