mirror of
				https://github.com/paperless-ngx/paperless-ngx.git
				synced 2025-11-03 03:16:10 -06:00 
			
		
		
		
	update links to reflect move to the-paperless-project
This commit is contained in:
		@@ -136,6 +136,6 @@ there, with a few small changes, but basically it boils down to:
 | 
			
		||||
I'm proud to say that the CoC has never had to be enforced because everyone has
 | 
			
		||||
been awesome, friendly, and professional.
 | 
			
		||||
 | 
			
		||||
.. _GitHub: https://github.com/danielquinn/paperless/issues
 | 
			
		||||
.. _GitHub: https://github.com/the-paperless-project/paperless/issues
 | 
			
		||||
.. _very well documented: https://www.python.org/dev/peps/pep-0008/
 | 
			
		||||
.. _code of conduct: https://github.com/danielquinn/paperless/blob/master/CODE_OF_CONDUCT.md
 | 
			
		||||
.. _code of conduct: https://github.com/the-paperless-project/paperless/blob/master/CODE_OF_CONDUCT.md
 | 
			
		||||
 
 | 
			
		||||
@@ -8,7 +8,7 @@ managed by way of modifying the code directly and issuing a pull request on
 | 
			
		||||
`GitHub`_.  However, over time the project has been evolving to be a little
 | 
			
		||||
more "pluggable" so that users can write their own stuff that talks to it.
 | 
			
		||||
 | 
			
		||||
.. _GitHub: https://github.com/danielquinn/paperless
 | 
			
		||||
.. _GitHub: https://github.com/the-paperless-project/paperless
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
.. _extending-parsers:
 | 
			
		||||
@@ -106,7 +106,7 @@ The core Paperless functionality is based on this design, so if you want to see
 | 
			
		||||
what a parser module should look like, have a look at `parsers.py`_,
 | 
			
		||||
`signals.py`_, and `apps.py`_ in the `paperless_tesseract`_ module.
 | 
			
		||||
 | 
			
		||||
.. _parsers.py: https://github.com/danielquinn/paperless/blob/master/src/paperless_tesseract/parsers.py
 | 
			
		||||
.. _signals.py: https://github.com/danielquinn/paperless/blob/master/src/paperless_tesseract/signals.py
 | 
			
		||||
.. _apps.py: https://github.com/danielquinn/paperless/blob/master/src/paperless_tesseract/apps.py
 | 
			
		||||
.. _paperless_tesseract: https://github.com/danielquinn/paperless/blob/master/src/paperless_tesseract/
 | 
			
		||||
.. _parsers.py: https://github.com/the-paperless-project/paperless/blob/master/src/paperless_tesseract/parsers.py
 | 
			
		||||
.. _signals.py: https://github.com/the-paperless-project/paperless/blob/master/src/paperless_tesseract/signals.py
 | 
			
		||||
.. _apps.py: https://github.com/the-paperless-project/paperless/blob/master/src/paperless_tesseract/apps.py
 | 
			
		||||
.. _paperless_tesseract: https://github.com/the-paperless-project/paperless/blob/master/src/paperless_tesseract/
 | 
			
		||||
 
 | 
			
		||||
@@ -52,7 +52,7 @@ with PDFs.  Often this is the case with Apple systems using HomeBrew, but other
 | 
			
		||||
Linuxes have been a problem as well.  The solution appears to be to install
 | 
			
		||||
ghostscript as well as ImageMagick:
 | 
			
		||||
 | 
			
		||||
.. _run into problems: https://github.com/danielquinn/paperless/issues/25
 | 
			
		||||
.. _run into problems: https://github.com/the-paperless-project/paperless/issues/25
 | 
			
		||||
 | 
			
		||||
.. code:: bash
 | 
			
		||||
 | 
			
		||||
@@ -92,7 +92,7 @@ enter it, and install the requirements using the ``requirements.txt`` file:
 | 
			
		||||
    $ . /path/to/arbitrary/directory/bin/activate
 | 
			
		||||
    $ pip install  --requirement /path/to/paperless/requirements.txt
 | 
			
		||||
 | 
			
		||||
Now you're ready to go.  Just remember to enter (activate) your virtualenv 
 | 
			
		||||
Now you're ready to go.  Just remember to enter (activate) your virtualenv
 | 
			
		||||
whenever you want to use Paperless.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -8,7 +8,7 @@ basic documentation is in order.  If you follow along in this document and
 | 
			
		||||
still have trouble, please open an `issue on GitHub`_ so I can fill in the
 | 
			
		||||
gaps.
 | 
			
		||||
 | 
			
		||||
.. _issue on GitHub: https://github.com/danielquinn/paperless/issues
 | 
			
		||||
.. _issue on GitHub: https://github.com/the-paperless-project/paperless/issues
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
.. _setup-download:
 | 
			
		||||
@@ -21,7 +21,7 @@ either by using ``git``:
 | 
			
		||||
 | 
			
		||||
.. code:: bash
 | 
			
		||||
 | 
			
		||||
    $ git clone https://github.com/danielquinn/paperless.git
 | 
			
		||||
    $ git clone https://github.com/the-paperless-project/paperless.git
 | 
			
		||||
    $ cd paperless
 | 
			
		||||
 | 
			
		||||
or just download the tarball and go that route:
 | 
			
		||||
@@ -29,7 +29,7 @@ or just download the tarball and go that route:
 | 
			
		||||
.. code:: bash
 | 
			
		||||
 | 
			
		||||
    $ cd to the directory where you want to run Paperless
 | 
			
		||||
    $ wget https://github.com/danielquinn/paperless/archive/master.zip
 | 
			
		||||
    $ wget https://github.com/the-paperless-project/paperless/archive/master.zip
 | 
			
		||||
    $ unzip master.zip
 | 
			
		||||
    $ cd paperless-master
 | 
			
		||||
 | 
			
		||||
@@ -147,15 +147,15 @@ Docker Method
 | 
			
		||||
   instructions in comments in the file. The only change that is a hard
 | 
			
		||||
   requirement is to specify where the consumption directory should
 | 
			
		||||
   mount.[#dockercomposeyml]_
 | 
			
		||||
	 
 | 
			
		||||
 | 
			
		||||
	 .. caution::
 | 
			
		||||
	 
 | 
			
		||||
 | 
			
		||||
	     If you are using NFS mounts for the consume directory you also need to
 | 
			
		||||
			 change the command to turn off inotify as it doesn't work with NFS
 | 
			
		||||
			 
 | 
			
		||||
 | 
			
		||||
			 `command: ["document_consumer", "--no-inotify"]`
 | 
			
		||||
			 
 | 
			
		||||
			 
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
5. Modify ``docker-compose.env`` and adapt the following environment variables:
 | 
			
		||||
 | 
			
		||||
   ``PAPERLESS_PASSPHRASE``
 | 
			
		||||
 
 | 
			
		||||
@@ -72,4 +72,4 @@ with a DPI of 300, then merging the images into the single PDF with
 | 
			
		||||
For more information on this and situations like it, you should take a look
 | 
			
		||||
at `Issue #118`_ as that's where this tip originated.
 | 
			
		||||
 | 
			
		||||
.. _Issue #118: https://github.com/danielquinn/paperless/issues/118
 | 
			
		||||
.. _Issue #118: https://github.com/the-paperless-project/paperless/issues/118
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user