diff --git a/README.rst b/README.rst index a23f8babe..6b461fb31 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,9 @@ 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| Scan, index, and archive all of your paper documents diff --git a/docs/setup.rst b/docs/setup.rst index ddc182178..fa35e91af 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -50,14 +50,22 @@ Standard (Bare Metal) 1. Install the requirements as per the :ref:`requirements ` page. 2. Change to the ``src`` directory in this repo. -3. Edit ``paperless/settings.py`` and be sure to set the values for - ``CONSUMPTION_DIR`` and ``PASSPHRASE`` at the bottom of the file. +3. Edit ``paperless/settings.py`` and be sure to set the values for: + * ``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``. 5. Create a user for your Paperless instance with ``./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 :``. + 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 - ``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 this time, you should start the consumer script with ``./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 provisioned... 3. Run ``vagrant ssh`` and once inside your new vagrant box, edit - ``/opt/paperless/src/paperless/settings.py``. Specifically, you need to make - sure that you set values for ``CONSUMPTION_DIR`` and ``PASSPHRASE`` at the - bottom of the file. + ``/opt/paperless/src/paperless/settings.py`` and set the values for: + * ``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 ``/opt/paperless/src/manage.py migrate``. 5. Still inside your vagrant box, create a user for your Paperless instance with ``/opt/paperless/src/manage.py createsuperuser``. Follow the prompts to diff --git a/src/documents/admin.py b/src/documents/admin.py index d706e54a6..6da26a897 100644 --- a/src/documents/admin.py +++ b/src/documents/admin.py @@ -31,6 +31,13 @@ def queryset(self, request, queryset): 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): search_fields = ("sender__name", "title", "content",) @@ -64,7 +71,7 @@ def tags_(self, obj): tags_.allow_tags = True admin.site.register(Sender) -admin.site.register(Tag) +admin.site.register(Tag, TagAdmin) admin.site.register(Document, DocumentAdmin) # Unless we implement multi-user, these default registrations don't make sense.