paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-04-09 09:58:20 -05:00
Code Issues Packages Projects Releases Wiki Activity

fix: formatting cleanup

Browse Source
This commit is contained in:
Daniel Quinn 2017-05-10 17:38:00 -07:00
parent 3477b96d87
commit 34bab04310
2 changed files with 28 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.rst
View File

@ -23,7 +23,8 @@ it... because paper. I wrote this to make my life easier.
How it Works How it Works
============ ============
Paperless does not control your scanner, it only helps you deal with what your scanner produces Paperless does not control your scanner, it only helps you deal with what your
scanner produces
1. Buy a document scanner like `this one`_ (used by me) or `this other one`_ 1. Buy a document scanner like `this one`_ (used by me) or `this other one`_
recommended by another user. recommended by another user.
@ -50,15 +51,15 @@ Stability
========= =========
Paperless is still under active development (just look at the git commit Paperless is still under active development (just look at the git commit
history) so don't expect it to be 100% stable. You can backup the sqlite3 history) so don't expect it to be 100% stable. You can backup the sqlite3
database, media directory and your configuration file to be on the safe side. database, media directory and your configuration file to be on the safe side.
Requirements Requirements
============ ============
This is all really a quite simple, shiny, user-friendly wrapper around some very This is all really a quite simple, shiny, user-friendly wrapper around some
powerful tools. very powerful tools.
* `ImageMagick`_ converts the images between colour and greyscale. * `ImageMagick`_ converts the images between colour and greyscale.
* `Tesseract`_ does the character recognition. * `Tesseract`_ does the character recognition.
@ -85,9 +86,9 @@ Similar Projects
There's another project out there called `Mayan EDMS`_ that has a surprising There's another project out there called `Mayan EDMS`_ that has a surprising
amount of technical overlap with Paperless. Also based on Django and using amount of technical overlap with Paperless. Also based on Django and using
a consumer model with Tesseract and Unpaper, Mayan EDMS is *much* more a consumer model with Tesseract and Unpaper, Mayan EDMS is *much* more
featureful and comes with a slick UI as well, but still in Python 2. It may be featureful and comes with a slick UI as well, but still in Python 2. It may be
that Paperless consumes fewer resources, but to be honest, this is just a guess that Paperless consumes fewer resources, but to be honest, this is just a guess
as I haven't tested this myself. One thing's for certain though, *Paperless* as I haven't tested this myself. One thing's for certain though, *Paperless*
is a **much** better name. is a **much** better name.

37
docs/setup.rst
View File

@ -4,8 +4,9 @@ Setup
===== =====
Paperless isn't a very complicated app, but there are a few components, so some Paperless isn't a very complicated app, but there are a few components, so some
basic documentation is in order. If you follow along in this document and still basic documentation is in order. If you follow along in this document and
have trouble, please open an `issue on GitHub`_ so I can fill in the gaps. 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/danielquinn/paperless/issues
@ -42,9 +43,9 @@ You can go multiple routes with setting up and running Paperless. The `Vagrant
route`_ is quick & easy, but means you're running a VM which comes with memory route`_ is quick & easy, but means you're running a VM which comes with memory
consumption etc. We also `support Docker`_, which you can use natively under consumption etc. We also `support Docker`_, which you can use natively under
Linux and in a VM with `Docker Machine`_ (this guide was written for native Linux and in a VM with `Docker Machine`_ (this guide was written for native
Docker usage under Linux, you might have to adapt it for Docker Machine.) Docker usage under Linux, you might have to adapt it for Docker Machine.)
Not to forget the virtualenv, this is similar to `bare metal`_ with the exception Not to forget the virtualenv, this is similar to `bare metal`_ with the
that you have to activate the virtualenv first. exception that you have to activate the virtualenv first.
Last but not least, the standard `bare metal`_ approach is a little more Last but not least, the standard `bare metal`_ approach is a little more
complicated, but worth it because it makes it easier should you want to complicated, but worth it because it makes it easier should you want to
contribute some code back. contribute some code back.
@ -62,8 +63,8 @@ Standard (Bare Metal)
1. Install the requirements as per the :ref:`requirements <requirements>` page. 1. Install the requirements as per the :ref:`requirements <requirements>` page.
2. Within the extract of master.zip go to the ``src`` directory. 2. Within the extract of master.zip go to the ``src`` directory.
3. Copy ``paperless.conf.example`` to ``/etc/paperless.conf`` also the virtual 3. Copy ``paperless.conf.example`` to ``/etc/paperless.conf`` also the virtual
envrionment look there for it and open it in your favourite editor. envrionment look there for it and open it in your favourite editor.
Because this file contains passwords it should only be readable by user root Because this file contains passwords it should only be readable by user root
and paperless ! Set the values for: and paperless ! Set the values for:
@ -78,10 +79,11 @@ Standard (Bare Metal)
5. Create a user for your Paperless instance with 5. Create a user for your Paperless instance with
``./manage.py createsuperuser``. Follow the prompts to create your user. ``./manage.py createsuperuser``. Follow the prompts to create your user.
6. Start the webserver with ``./manage.py runserver <IP>:<PORT>``. 6. Start the webserver with ``./manage.py runserver <IP>:<PORT>``.
If no specifc IP or port are given, the default is ``127.0.0.1:8000`` If no specifc IP or port are given, the default is ``127.0.0.1:8000``
also known as http://localhost:8000/. also known as http://localhost:8000/.
You should now be able to visit your (empty) at `Paperless webserver`_ or You should now be able to visit your (empty) at `Paperless webserver`_ or
whatever you chose before. You can login with the user/pass you created in #5. whatever you chose before. You can login with the user/pass you created in
#5.
7. In a separate window, change to the ``src`` directory in this repo again, 7. In a separate window, change to the ``src`` directory in this repo again,
but this time, you should start the consumer script with but this time, you should start the consumer script with
``./manage.py document_consumer``. ``./manage.py document_consumer``.
@ -303,15 +305,16 @@ Standard (Bare Metal, Systemd)
If you're running on a bare metal system that's using Systemd, you can use the If you're running on a bare metal system that's using Systemd, you can use the
service unit files in the ``scripts`` directory to set this up. You'll need to service unit files in the ``scripts`` directory to set this up. You'll need to
create a user called ``paperless`` (without login (if not already done so #5)) and create a user called ``paperless`` (without login (if not already done so #5))
setup Paperless to be in a place that this new user can read and write to. Be sure and setup Paperless to be in a place that this new user can read and write to.
to edit the service scripts to point to the proper location of your paperless install, Be sure to edit the service scripts to point to the proper location of your
referencing the appropriate Python binary. For example: paperless install, referencing the appropriate Python binary. For example:
``ExecStart=/path/to/python3 /path/to/paperless/src/manage.py document_consumer``. ``ExecStart=/path/to/python3 /path/to/paperless/src/manage.py document_consumer``.
If you don't want to make a new user, you can change the ``Group`` and ``User`` variables If you don't want to make a new user, you can change the ``Group`` and ``User``
accordingly. variables accordingly.
Then, you can just tell Systemd as ``root`` (or using ``sudo``) to enable the two ``.service`` files:: Then, you can just tell Systemd as ``root`` (or using ``sudo``) to enable the
two ``.service`` files::
# systemctl enable /path/to/paperless/scripts/paperless-consumer.service # systemctl enable /path/to/paperless/scripts/paperless-consumer.service
# systemctl enable /path/to/paperless/scripts/paperless-webserver.service # systemctl enable /path/to/paperless/scripts/paperless-webserver.service