mirror of
				https://github.com/paperless-ngx/paperless-ngx.git
				synced 2025-10-28 03:46:06 -05:00 
			
		
		
		
	Update name in docs (#80)
* Update name in docs Will document on #52 what's left do do. * Update usage_overview.rst
This commit is contained in:
		
							
								
								
									
										4
									
								
								.github/ISSUE_TEMPLATE/bug_report.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										4
									
								
								.github/ISSUE_TEMPLATE/bug_report.md
									
									
									
									
										vendored
									
									
								
							| @@ -8,11 +8,11 @@ assignees: '' | |||||||
| --- | --- | ||||||
|  |  | ||||||
| <!--- | <!--- | ||||||
| => Before opening an issue, please check the documentation and see if it helps you resolve your issue: https://paperless-ng.readthedocs.io/en/latest/troubleshooting.html | => Before opening an issue, please check the documentation and see if it helps you resolve your issue: https://paperless-ngx.readthedocs.io/en/latest/troubleshooting.html | ||||||
| => Please also make sure that you followed the installation instructions. | => Please also make sure that you followed the installation instructions. | ||||||
| => Please search the issues and look for similar issues before opening a bug report. | => Please search the issues and look for similar issues before opening a bug report. | ||||||
|  |  | ||||||
| => If you would like to submit a feature request please submit one under https://github.com/jonaswinkler/paperless-ng/discussions/categories/feature-requests | => 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-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. | ||||||
|  |  | ||||||
|   | |||||||
							
								
								
									
										2
									
								
								.github/ISSUE_TEMPLATE/other.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								.github/ISSUE_TEMPLATE/other.md
									
									
									
									
										vendored
									
									
								
							| @@ -11,7 +11,7 @@ assignees: '' | |||||||
|  |  | ||||||
| => Discussions, Feedback and other suggestions belong in the "Discussion" section and not on the issue tracker. | => Discussions, Feedback and other suggestions belong in the "Discussion" section and not on the issue tracker. | ||||||
|  |  | ||||||
| => If you would like to submit a feature request please submit one under https://github.com/jonaswinkler/paperless-ng/discussions/categories/feature-requests | => 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-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. | ||||||
|  |  | ||||||
|   | |||||||
| @@ -64,9 +64,9 @@ Updating Paperless | |||||||
| Docker Route | Docker Route | ||||||
| ============ | ============ | ||||||
|  |  | ||||||
| If a new release of paperless-ng is available, upgrading depends on how you | If a new release of paperless-ngx is available, upgrading depends on how you | ||||||
| installed paperless-ng in the first place. The releases are available at the | installed paperless-ngx in the first place. The releases are available at the | ||||||
| `release page <https://github.com/jonaswinkler/paperless-ng/releases>`_. | `release page <https://github.com/paperless-ngx/paperless-ngx/releases>`_. | ||||||
|  |  | ||||||
| First of all, ensure that paperless is stopped. | First of all, ensure that paperless is stopped. | ||||||
|  |  | ||||||
| @@ -98,14 +98,14 @@ B.  If you built the image yourself, do the following: | |||||||
|  |  | ||||||
| Running ``docker-compose up`` will also apply any new database migrations. | Running ``docker-compose up`` will also apply any new database migrations. | ||||||
| If you see everything working, press CTRL+C once to gracefully stop paperless. | If you see everything working, press CTRL+C once to gracefully stop paperless. | ||||||
| Then you can start paperless-ng with ``-d`` to have it run in the background. | Then you can start paperless-ngx with ``-d`` to have it run in the background. | ||||||
|  |  | ||||||
|     .. note:: |     .. note:: | ||||||
|  |  | ||||||
|         In version 0.9.14, the update process was changed. In 0.9.13 and earlier, the |         In version 0.9.14, the update process was changed. In 0.9.13 and earlier, the | ||||||
|         docker-compose files specified exact versions and pull won't automatically |         docker-compose files specified exact versions and pull won't automatically | ||||||
|         update to newer versions. In order to enable updates as described above, either |         update to newer versions. In order to enable updates as described above, either | ||||||
|         get the new ``docker-compose.yml`` file from `here <https://github.com/jonaswinkler/paperless-ng/tree/master/docker/compose>`_ |         get the new ``docker-compose.yml`` file from `here <https://github.com/paperless-ngx/paperless-ngx/tree/master/docker/compose>`_ | ||||||
|         or edit the ``docker-compose.yml`` file, find the line that says |         or edit the ``docker-compose.yml`` file, find the line that says | ||||||
|  |  | ||||||
|             .. code:: |             .. code:: | ||||||
|   | |||||||
| @@ -5,7 +5,7 @@ Contributing to Paperless | |||||||
|  |  | ||||||
| .. warning:: | .. warning:: | ||||||
|  |  | ||||||
|     This section is not updated to paperless-ng yet. |     This section is not updated to paperless-ngx yet. | ||||||
|  |  | ||||||
| Maybe you've been using Paperless for a while and want to add a feature or two, | Maybe you've been using Paperless for a while and want to add a feature or two, | ||||||
| or maybe you've come across a bug that you have some ideas how to solve.  The | or maybe you've come across a bug that you have some ideas how to solve.  The | ||||||
|   | |||||||
| @@ -3,7 +3,7 @@ | |||||||
| Paperless development | Paperless development | ||||||
| ##################### | ##################### | ||||||
|  |  | ||||||
| This section describes the steps you need to take to start development on paperless-ng. | This section describes the steps you need to take to start development on paperless-ngx. | ||||||
|  |  | ||||||
| Check out the source from github. The repository is organized in the following way: | Check out the source from github. The repository is organized in the following way: | ||||||
|  |  | ||||||
|   | |||||||
| @@ -45,7 +45,7 @@ out of that folder to use them elsewhere. Here are a couple notes about that. | |||||||
|     :ref:`configuring the filename format <advanced-file_name_handling>`. |     :ref:`configuring the filename format <advanced-file_name_handling>`. | ||||||
| *   :ref:`The exporter <utilities-exporter>` is another easy way to get your files out of paperless with reasonable file names. | *   :ref:`The exporter <utilities-exporter>` is another easy way to get your files out of paperless with reasonable file names. | ||||||
|  |  | ||||||
| **Q:** *What file types does paperless-ng support?* | **Q:** *What file types does paperless-ngx support?* | ||||||
|  |  | ||||||
| **A:** Currently, the following files are supported: | **A:** Currently, the following files are supported: | ||||||
|  |  | ||||||
| @@ -58,7 +58,7 @@ out of that folder to use them elsewhere. Here are a couple notes about that. | |||||||
| Paperless determines the type of a file by inspecting its content. The | Paperless determines the type of a file by inspecting its content. The | ||||||
| file extensions do not matter. | file extensions do not matter. | ||||||
|  |  | ||||||
| **Q:** *Will paperless-ng run on Raspberry Pi?* | **Q:** *Will paperless-ngx run on Raspberry Pi?* | ||||||
|  |  | ||||||
| **A:** The short answer is yes. I've tested it on a Raspberry Pi 3 B. | **A:** The short answer is yes. I've tested it on a Raspberry Pi 3 B. | ||||||
| The long answer is that certain parts of | The long answer is that certain parts of | ||||||
| @@ -73,7 +73,7 @@ in your browser and paperless has to do much less work to serve the data. | |||||||
|     power. See :ref:`setup-less_powerful_devices` for details. |     power. See :ref:`setup-less_powerful_devices` for details. | ||||||
|  |  | ||||||
|  |  | ||||||
| **Q:** *How do I install paperless-ng on Raspberry Pi?* | **Q:** *How do I install paperless-ngx on Raspberry Pi?* | ||||||
|  |  | ||||||
| **A:** Docker images are available for arm and arm64 hardware, so just follow | **A:** Docker images are available for arm and arm64 hardware, so just follow | ||||||
| the docker-compose instructions. Apart from more required disk space compared to | the docker-compose instructions. Apart from more required disk space compared to | ||||||
|   | |||||||
| @@ -32,9 +32,9 @@ repository right away. | |||||||
|  |  | ||||||
| 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-ng. | avoids confusion between paperless and paperless-ngx. | ||||||
|  |  | ||||||
| If you want to learn about what's different in paperless-ng, check out these | If you want to learn about what's different in paperless-ngx, 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. | ||||||
| @@ -46,12 +46,12 @@ resources in the documentation: | |||||||
|     the consumption directory. This means that you can select text in |     the consumption directory. This means that you can select text in | ||||||
|     image-only documents coming from your scanner. |     image-only documents coming from your scanner. | ||||||
| *   See :ref:`this note <utilities-encyption>` about GnuPG encryption in | *   See :ref:`this note <utilities-encyption>` about GnuPG encryption in | ||||||
|     paperless-ng. |     paperless-ngx. | ||||||
| *   Paperless is now integrated with a | *   Paperless is now integrated with a | ||||||
|     :ref:`task processing queue <setup-task_processor>` that tells you |     :ref:`task processing queue <setup-task_processor>` that tells you | ||||||
|     at a glance when and why something is not working. |     at a glance when and why something is not working. | ||||||
| *   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-ng. |     in paperless-ngx. | ||||||
|  |  | ||||||
| It would be great if this project could eventually merge back into the main | 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. | repository, but it needs a lot more work before that can happen. | ||||||
|   | |||||||
| @@ -4,7 +4,7 @@ | |||||||
| Screenshots | Screenshots | ||||||
| *********** | *********** | ||||||
|  |  | ||||||
| This is what paperless-ng looks like. You shouldn't use paperless to index | This is what paperless-ngx looks like. You shouldn't use paperless to index | ||||||
| research papers though, its a horrible tool for that job. | research papers though, its a horrible tool for that job. | ||||||
|  |  | ||||||
| The dashboard shows customizable views on your document and allows document uploads: | The dashboard shows customizable views on your document and allows document uploads: | ||||||
|   | |||||||
| @@ -6,7 +6,7 @@ Setup | |||||||
| Overview of Paperless-ng | Overview of Paperless-ng | ||||||
| ######################## | ######################## | ||||||
|  |  | ||||||
| Compared to paperless, paperless-ng 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 | ||||||
| the system, it also brings many benefits. | the system, it also brings many benefits. | ||||||
|  |  | ||||||
| @@ -125,7 +125,7 @@ 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-ng` to have a place for your configuration files and consumption directory. | ||||||
|  |  | ||||||
| 2.  Go to the `/docker/compose directory on the project page <https://github.com/jonaswinkler/paperless-ng/tree/master/docker/compose>`_ | 2.  Go to the `/docker/compose directory on the project page <https://github.com/paperless-ngx/paperless-ngx/tree/master/docker/compose>`_ | ||||||
|     and download one of the `docker-compose.*.yml` files, depending on which database backend you |     and download one of the `docker-compose.*.yml` files, depending on which database backend you | ||||||
|     want to use. Rename this file to `docker-compose.yml`. |     want to use. Rename this file to `docker-compose.yml`. | ||||||
|     If you want to enable optional support for Office documents, download a file with `-tika` in the file name. |     If you want to enable optional support for Office documents, download a file with `-tika` in the file name. | ||||||
| @@ -244,7 +244,7 @@ Build the Docker image yourself | |||||||
|  |  | ||||||
|     .. code:: shell-session |     .. code:: shell-session | ||||||
|  |  | ||||||
|         git clone https://github.com/jonaswinkler/paperless-ng |         git clone https://github.com/paperless-ngx/paperless-ngx | ||||||
|  |  | ||||||
|     The master branch always reflects the latest stable version. |     The master branch always reflects the latest stable version. | ||||||
|  |  | ||||||
| @@ -338,7 +338,7 @@ writing. Windows is not and will never be supported. | |||||||
| 3.  Optional. Install ``postgresql`` and configure a database, user and password for paperless. If you do not wish | 3.  Optional. Install ``postgresql`` and configure a database, user and password for paperless. If you do not wish | ||||||
|     to use PostgreSQL, SQLite is available as well. |     to use PostgreSQL, SQLite is available as well. | ||||||
|  |  | ||||||
| 4.  Get the release archive from `<https://github.com/jonaswinkler/paperless-ng/releases>`_. | 4.  Get the release archive from `<https://github.com/paperless-ngx/paperless-ngx/releases>`_. | ||||||
|     If you clone the git repo as it is, you also have to compile the front end by yourself. |     If you clone the git repo as it is, you also have to compile the front end by yourself. | ||||||
|     Extract the archive to a place from where you wish to execute it, such as ``/opt/paperless``. |     Extract the archive to a place from where you wish to execute it, such as ``/opt/paperless``. | ||||||
|  |  | ||||||
| @@ -483,7 +483,7 @@ Install Paperless using ansible | |||||||
| 		Additionally, only i386 or amd64 based hosts are supported right now, i.e. installation on arm hosts will fail. | 		Additionally, only i386 or amd64 based hosts are supported right now, i.e. installation on arm hosts will fail. | ||||||
|  |  | ||||||
| 1.  Install ansible 2.7+ on the management node. | 1.  Install ansible 2.7+ on the management node. | ||||||
|     This may be the target host paperless-ng is being installed on or any remote host which can access the target host. |     This may be the target host paperless-ngx is being installed on or any remote host which can access the target host. | ||||||
|     For further details, check the ansible `inventory <https://docs.ansible.com/ansible/latest/user_guide/intro_inventory.html>`_ documentation. |     For further details, check the ansible `inventory <https://docs.ansible.com/ansible/latest/user_guide/intro_inventory.html>`_ documentation. | ||||||
|  |  | ||||||
|     On Debian and Ubuntu, the official repositories should provide a suitable version: |     On Debian and Ubuntu, the official repositories should provide a suitable version: | ||||||
| @@ -580,12 +580,12 @@ Install Paperless using ansible | |||||||
|  |  | ||||||
|         ansible-playbook playbook.yml |         ansible-playbook playbook.yml | ||||||
|  |  | ||||||
|     When this step completes successfully, paperless-ng will be available on the target host at ``http://127.0.0.1:8000`` (or the address you configured). |     When this step completes successfully, paperless-ngx will be available on the target host at ``http://127.0.0.1:8000`` (or the address you configured). | ||||||
|  |  | ||||||
| Migration to paperless-ng | Migration to paperless-ngx | ||||||
| ######################### | ######################### | ||||||
|  |  | ||||||
| At its core, paperless-ng is still paperless and fully compatible. However, some | At its core, paperless-ngx is still paperless and fully compatible. However, some | ||||||
| things have changed under the hood, so you need to adapt your setup depending on | things have changed under the hood, so you need to adapt your setup depending on | ||||||
| how you installed paperless. | how you installed paperless. | ||||||
|  |  | ||||||
| @@ -601,10 +601,10 @@ The important things to keep in mind are as follows: | |||||||
|   such as email checking and maintenance, requires a `redis`_ message broker |   such as email checking and maintenance, requires a `redis`_ message broker | ||||||
|   instance. The docker-compose route takes care of that. |   instance. The docker-compose route takes care of that. | ||||||
| * The layout of the folder structure for your documents and data remains the | * The layout of the folder structure for your documents and data remains the | ||||||
|   same, so you can just plug your old docker volumes into paperless-ng and |   same, so you can just plug your old docker volumes into paperless-ngx and | ||||||
|   expect it to find everything where it should be. |   expect it to find everything where it should be. | ||||||
|  |  | ||||||
| Migration to paperless-ng is then performed in a few simple steps: | Migration to paperless-ngx is then performed in a few simple steps: | ||||||
|  |  | ||||||
| 1.  Stop paperless. | 1.  Stop paperless. | ||||||
|  |  | ||||||
| @@ -614,20 +614,20 @@ Migration to paperless-ng is then performed in a few simple steps: | |||||||
|         $ docker-compose down |         $ docker-compose down | ||||||
|  |  | ||||||
| 2.  Do a backup for two purposes: If something goes wrong, you still have your | 2.  Do a backup for two purposes: If something goes wrong, you still have your | ||||||
|     data. Second, if you don't like paperless-ng, you can switch back to |     data. Second, if you don't like paperless-ngx, you can switch back to | ||||||
|     paperless. |     paperless. | ||||||
|  |  | ||||||
| 3.  Download the latest release of paperless-ng. You can either go with the | 3.  Download the latest release of paperless-ngx. You can either go with the | ||||||
|     docker-compose files from `here <https://github.com/jonaswinkler/paperless-ng/tree/master/docker/compose>`__ |     docker-compose files from `here <https://github.com/paperless-ngx/paperless-ngx/tree/master/docker/compose>`__ | ||||||
|     or clone the repository to build the image yourself (see :ref:`above <setup-docker_build>`). |     or clone the repository to build the image yourself (see :ref:`above <setup-docker_build>`). | ||||||
|     You can either replace your current paperless folder or put paperless-ng |     You can either replace your current paperless folder or put paperless-ngx | ||||||
|     in a different location. |     in a different location. | ||||||
|  |  | ||||||
|     .. caution:: |     .. caution:: | ||||||
|  |  | ||||||
|         Paperless-ng includes a ``.env`` file. This will set the |         Paperless-ng 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-ng. However, if you experience that paperless-ng |         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 | ||||||
|  |  | ||||||
|         .. code:: shell-session |         .. code:: shell-session | ||||||
| @@ -657,7 +657,7 @@ Migration to paperless-ng is then performed in a few simple steps: | |||||||
|     This will migrate your database and create the search index. After that, |     This will migrate your database and create the search index. After that, | ||||||
|     paperless will take care of maintaining the index by itself. |     paperless will take care of maintaining the index by itself. | ||||||
|  |  | ||||||
| 8.  Start paperless-ng. | 8.  Start paperless-ngx. | ||||||
|  |  | ||||||
|     .. code:: bash |     .. code:: bash | ||||||
|  |  | ||||||
|   | |||||||
| @@ -126,8 +126,8 @@ which not only has document upload, but also document browsing and download feat | |||||||
| IMAP (Email) | IMAP (Email) | ||||||
| ============ | ============ | ||||||
|  |  | ||||||
| You can tell paperless-ng to consume documents from your email accounts. | You can tell paperless-ngx to consume documents from your email accounts. | ||||||
| This is a very flexible and powerful feature if you regularly received documents | This is a very flexible and powerful feature, if you regularly received documents | ||||||
| via mail that you need to archive. The mail consumer can be configured by using the | via mail that you need to archive. The mail consumer can be configured by using the | ||||||
| admin interface in the following manner: | admin interface in the following manner: | ||||||
|  |  | ||||||
|   | |||||||
| @@ -5,7 +5,7 @@ | |||||||
|                SilN@@@@@@@ |                SilN@@@@@@@ | ||||||
|             *Q  *@@@@@@@@S        /= = = = = = = = = = = = = = = = = =\ |             *Q  *@@@@@@@@S        /= = = = = = = = = = = = = = = = = =\ | ||||||
|           *@   B@@@@@@@@N        ||                                   || |           *@   B@@@@@@@@N        ||                                   || | ||||||
|  N       R$  A@@@@@@@@@@         ||           PAPERLESS-NG            || |  N       R$  A@@@@@@@@@@         ||           PAPERLESS-NGX           || | ||||||
| x@@     $U  B@@@@@@@@@R          ||                                   || | x@@     $U  B@@@@@@@@@R          ||                                   || | ||||||
| N@@N^   @  N@@@@@@@@@*            \= = = = = = = = = = = = = = = = = =/ | N@@N^   @  N@@@@@@@@@*            \= = = = = = = = = = = = = = = = = =/ | ||||||
| |@@@u   @ E@@@@@@@@l | |@@@u   @ E@@@@@@@@l | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user
	 Filip Kraus
					Filip Kraus