diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 2fc3ccd19..f542d48bf 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -14,7 +14,7 @@ assignees: '' => If you would like to submit a feature request please submit one under https://github.com/paperless-ngx/paperless-ngx/discussions/categories/feature-requests -=> If you encounter issues while installing of configuring Paperless-ng, please post that in the "Support" section of the discussions. Remember that Paperless successfully runs on a variety of different systems. If paperless does not start, it's probably an issue with your system, and not an issue of paperless. +=> If you encounter issues while installing of configuring Paperless-ngx, please post that in the "Support" section of the discussions. Remember that Paperless successfully runs on a variety of different systems. If paperless does not start, it's probably an issue with your system, and not an issue of paperless. => Don't remove the [BUG] prefix from the title. --> diff --git a/.github/ISSUE_TEMPLATE/other.md b/.github/ISSUE_TEMPLATE/other.md index 52492c16d..7d084247c 100644 --- a/.github/ISSUE_TEMPLATE/other.md +++ b/.github/ISSUE_TEMPLATE/other.md @@ -13,7 +13,7 @@ assignees: '' => If you would like to submit a feature request please submit one under https://github.com/paperless-ngx/paperless-ngx/discussions/categories/feature-requests -=> If you encounter issues while installing of configuring Paperless-ng, please post that in the "Support" section of the discussions. Remember that Paperless successfully runs on a variety of different systems. If paperless does not start, it's probably is an issue with your system, and not an issue of paperless. +=> If you encounter issues while installing of configuring Paperless-ngx, please post that in the "Support" section of the discussions. Remember that Paperless successfully runs on a variety of different systems. If paperless does not start, it's probably is an issue with your system, and not an issue of paperless. => Don't remove the [Other] prefix from the title. diff --git a/README.md b/README.md index 5ca4e5eb2..8e20aeb73 100644 --- a/README.md +++ b/README.md @@ -99,7 +99,7 @@ For bugs please [open an issue](https://github.com/paperless-ngx/paperless-ngx/i Paperless has been around a while now, and people are starting to build stuff on top of it. If you're one of those people, we can add your project to this list: -* [Paperless App](https://github.com/bauerj/paperless_app): An Android/iOS app for Paperless-ngx. Also works with the original Paperless and Paperless-ng. +* [Paperless App](https://github.com/bauerj/paperless_app): An Android/iOS app for Paperless-ngx. Also works with the original Paperless and Paperless-ngx. * [Paperless Share](https://github.com/qcasey/paperless_share). Share any files from your Android application with paperless. Very simple, but works with all of the mobile scanning apps out there that allow you to share scanned documents. * [Scan to Paperless](https://github.com/sbrunner/scan-to-paperless): Scan and prepare (crop, deskew, OCR, ...) your documents for Paperless. diff --git a/docs/administration.rst b/docs/administration.rst index e3cd7b188..1a9dfd548 100644 --- a/docs/administration.rst +++ b/docs/administration.rst @@ -468,7 +468,7 @@ Documents can be stored in Paperless using GnuPG encryption. .. danger:: - Encryption is deprecated since paperless-ng 0.9 and doesn't really provide any + Encryption is deprecated since paperless-ngx 0.9 and doesn't really provide any additional security, since you have to store the passphrase in a configuration file on the same system as the encrypted documents for paperless to work. Furthermore, the entire text content of the documents is stored plain in the diff --git a/docs/advanced_usage.rst b/docs/advanced_usage.rst index 2363ec62a..a727c94f8 100644 --- a/docs/advanced_usage.rst +++ b/docs/advanced_usage.rst @@ -174,7 +174,7 @@ The post consumption script cannot cancel the consumption process. Docker ------ -Assumed you have ``/home/foo/paperless-ng/scripts/post-consumption-example.sh``. +Assumed you have ``/home/foo/paperless-ngx/scripts/post-consumption-example.sh``. You can pass that script into the consumer container via a host mount in your ``docker-compose.yml``. @@ -184,10 +184,10 @@ You can pass that script into the consumer container via a host mount in your `` ... volumes: ... - - /home/paperless-ng/scripts:/path/in/container/scripts/ + - /home/paperless-ngx/scripts:/path/in/container/scripts/ ... -Example (docker-compose.yml): ``- /home/foo/paperless-ng/scripts:/usr/src/paperless/scripts`` +Example (docker-compose.yml): ``- /home/foo/paperless-ngx/scripts:/usr/src/paperless/scripts`` which in turn requires the variable ``PAPERLESS_POST_CONSUME_SCRIPT`` in ``docker-compose.env`` to point to ``/path/in/container/scripts/post-consumption-example.sh``. @@ -195,11 +195,11 @@ Example (docker-compose.env): ``PAPERLESS_POST_CONSUME_SCRIPT=/usr/src/paperless Troubleshooting: -- Monitor the docker-compose log ``cd ~/paperless-ng; docker-compose logs -f`` +- Monitor the docker-compose log ``cd ~/paperless-ngx; docker-compose logs -f`` - Check your script's permission e.g. in case of permission error ``sudo chmod 755 post-consumption-example.sh`` - Pipe your scripts's output to a log file e.g. ``echo "${DOCUMENT_ID}" | tee --append /usr/src/paperless/scripts/post-consumption-example.log`` -.. _post-consumption-example.sh: https://github.com/jonaswinkler/paperless-ng/blob/master/scripts/post-consumption-example.sh +.. _post-consumption-example.sh: https://github.com/jonaswinkler/paperless-ngx/blob/master/scripts/post-consumption-example.sh .. _advanced-file_name_handling: diff --git a/docs/api.rst b/docs/api.rst index 3a9d244c5..1d5b3f1b2 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -255,7 +255,7 @@ process itself is available, since that happens in a different process. API Versioning ############## -The REST API is versioned since Paperless-ng 1.3.0. +The REST API is versioned since Paperless-ngx 1.3.0. * Versioning ensures that changes to the API don't break older clients. * Clients specify the specific version of the API they wish to use with every request and Paperless will handle the request using the specified API version. diff --git a/docs/index.rst b/docs/index.rst index 8348d0f92..ec436b5c1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -36,7 +36,7 @@ NG stands for both Angular (the framework used for the Frontend) and next-gen. Publishing this project under a different name also avoids confusion between paperless and paperless-ngx. -If you want to learn about what's different in paperless-ng from Paperless, check out these +If you want to learn about what's different in paperless-ngx from Paperless, check out these resources in the documentation: * :ref:`Some screenshots ` of the new UI are available. diff --git a/docs/setup.rst b/docs/setup.rst index b6aa0f42c..5ab54fa96 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -117,7 +117,7 @@ performs all the steps described in :ref:`setup-docker_hub` automatically. Install Paperless from Docker Hub ================================= -1. Login with your user and create a folder in your home-directory `mkdir -v ~/paperless-ng` to have a place for your configuration files and consumption directory. +1. Login with your user and create a folder in your home-directory `mkdir -v ~/paperless-ngx` to have a place for your configuration files and consumption directory. 2. Go to the `/docker/compose directory on the project page `_ and download one of the `docker-compose.*.yml` files, depending on which database backend you