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

Merge branch 'master' into feature/images-as-docs

Browse Source
This commit is contained in:
Daniel Quinn
2016-01-29 23:41:13 +00:00
parent ace9389e5f cf4c437eca
commit 84d5f8cc5d
3 changed files with 32 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.rst
View File

@@ -1,5 +1,9 @@
Paperless Paperless
######### #########
.. image:: https://badges.gitter.im/danielquinn/paperless.svg
:alt: Join the chat at https://gitter.im/danielquinn/paperless
:target: https://gitter.im/danielquinn/paperless?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
|Documentation| |Documentation|
Scan, index, and archive all of your paper documents Scan, index, and archive all of your paper documents

27
docs/setup.rst
View File

@@ -50,14 +50,22 @@ 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. Change to the ``src`` directory in this repo. 2. Change to the ``src`` directory in this repo.
3. Edit ``paperless/settings.py`` and be sure to set the values for 3. Edit ``paperless/settings.py`` and be sure to set the values for:
``CONSUMPTION_DIR`` and ``PASSPHRASE`` at the bottom of the file. * ``CONSUMPTION_DIR``: this is where your documents will be dumped to be
consumed by Paperless.
* ``PASSPHRASE``: this is the passphrase Paperless uses to encrypt/decrypt
the original document. The default value attempts to source the
passphrase from the environment, so if you don't set it to a static value
here, you must set ``PAPERLESS_PASSPHRASE=some-secret-string`` on the
command line whenever invoking the consumer or webserver.
4. Initialise the database with ``./manage.py migrate``. 4. Initialise the database with ``./manage.py migrate``.
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``. 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``.
You should now be able to visit your (empty) `Paperless webserver`_ at You should now be able to visit your (empty) `Paperless webserver`_ at
``127.0.0.1:8000``. You can login with the user/pass you created in #5. ``127.0.0.1:8000`` (or whatever you chose). 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, but 7. In a separate window, change to the ``src`` directory in this repo again, but
this time, you should start the consumer script with this time, you should start the consumer script with
``./manage.py document_consumer``. ``./manage.py document_consumer``.
@@ -78,9 +86,14 @@ Vagrant Method
2. Run ``vagrant up``. An instance will start up for you. When it's ready and 2. Run ``vagrant up``. An instance will start up for you. When it's ready and
provisioned... provisioned...
3. Run ``vagrant ssh`` and once inside your new vagrant box, edit 3. Run ``vagrant ssh`` and once inside your new vagrant box, edit
``/opt/paperless/src/paperless/settings.py``. Specifically, you need to make ``/opt/paperless/src/paperless/settings.py`` and set the values for:
sure that you set values for ``CONSUMPTION_DIR`` and ``PASSPHRASE`` at the * ``CONSUMPTION_DIR``: this is where your documents will be dumped to be
bottom of the file. consumed by Paperless.
* ``PASSPHRASE``: this is the passphrase Paperless uses to encrypt/decrypt
the original document. The default value attempts to source the
passphrase from the environment, so if you don't set it to a static value
here, you must set ``PAPERLESS_PASSPHRASE=some-secret-string`` on the
command line whenever invoking the consumer or webserver.
4. Initialise the database with ``/opt/paperless/src/manage.py migrate``. 4. Initialise the database with ``/opt/paperless/src/manage.py migrate``.
5. Still inside your vagrant box, create a user for your Paperless instance with 5. Still inside your vagrant box, create a user for your Paperless instance with
``/opt/paperless/src/manage.py createsuperuser``. Follow the prompts to ``/opt/paperless/src/manage.py createsuperuser``. Follow the prompts to

9
src/documents/admin.py
View File

@@ -31,6 +31,13 @@ class MonthListFilter(admin.SimpleListFilter):
return queryset.filter(created__year=year, created__month=month) return queryset.filter(created__year=year, created__month=month)
class TagAdmin(admin.ModelAdmin):
list_display = ("name", "colour", "match", "matching_algorithm")
list_filter = ("colour", "matching_algorithm")
list_editable = ("colour", "match", "matching_algorithm")
class DocumentAdmin(admin.ModelAdmin): class DocumentAdmin(admin.ModelAdmin):
search_fields = ("sender__name", "title", "content",) search_fields = ("sender__name", "title", "content",)
@@ -64,7 +71,7 @@ class DocumentAdmin(admin.ModelAdmin):
tags_.allow_tags = True tags_.allow_tags = True
admin.site.register(Sender) admin.site.register(Sender)
admin.site.register(Tag) admin.site.register(Tag, TagAdmin)
admin.site.register(Document, DocumentAdmin) admin.site.register(Document, DocumentAdmin)
# Unless we implement multi-user, these default registrations don't make sense. # Unless we implement multi-user, these default registrations don't make sense.