mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2025-04-02 13:45:10 -05:00
113 lines
4.1 KiB
ReStructuredText
113 lines
4.1 KiB
ReStructuredText
.. _setup:
|
|
|
|
Setup
|
|
=====
|
|
|
|
Paperless isn't a very complicated app, but there are a few components, so some
|
|
basic documentation is in order. If you go 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
|
|
|
|
|
|
.. _setup-download:
|
|
|
|
Download
|
|
--------
|
|
|
|
The source is currently only available via GitHub, so grab it from there, either
|
|
by using ``git``:
|
|
|
|
.. code:: bash
|
|
|
|
$ git clone github.com:danielquinn/paperless.git
|
|
$ cd paperless
|
|
|
|
or just download the tarball and go that route:
|
|
|
|
.. code:: bash
|
|
|
|
$ wget https://github.com/danielquinn/paperless/archive/master.zip
|
|
$ unzip master.zip
|
|
$ cd paperless-master
|
|
|
|
|
|
.. _setup-installation:
|
|
|
|
Installation & Configuration
|
|
----------------------------
|
|
|
|
You can go two routes with setting up and running Paperless. The *Vagrant*
|
|
route is quick & easy, but means you're running a VM which comes with memory
|
|
consumption etc. Alternatively the standard, "bare metal" approach is a little
|
|
more complicated.
|
|
|
|
|
|
.. _setup-installation-standard:
|
|
|
|
Standard (Bare Metal)
|
|
.....................
|
|
|
|
1. Install the requirements as per the :ref:`requirements <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.
|
|
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``.
|
|
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.
|
|
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``.
|
|
8. Scan something. Put it in the ``CONSUMPTION_DIR``.
|
|
9. Wait a few minutes
|
|
10. Visit the document list on your webserver, and it should be there, indexed
|
|
and downloadable.
|
|
|
|
.. _Paperless webserver: http://127.0.0.1:8000
|
|
|
|
|
|
.. _setup-installation-vagrant:
|
|
|
|
Vagrant Method
|
|
..............
|
|
|
|
1. Install `Vagrant`_. How you do that is really between you and your OS.
|
|
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.
|
|
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
|
|
create your user.
|
|
6. Start the webserver with ``/opt/paperless/src/manage.py runserver 0.0.0.0:8000``.
|
|
You should now be able to visit your (empty) `Paperless webserver`_ at
|
|
``172.28.128.4:8000``. You can login with the user/pass you created in #5.
|
|
7. In a separate window, run ``vagrant ssh`` again, but this time once inside
|
|
your vagrant instance, you should start the consumer script with
|
|
``/opt/paperless/src/manage.py document_consumer``.
|
|
8. Scan something. Put it in the ``CONSUMPTION_DIR``.
|
|
9. Wait a few minutes
|
|
10. Visit the document list on your webserver, and it should be there, indexed
|
|
and downloadable.
|
|
|
|
.. _Vagrant: https://vagrantup.com/
|
|
.. _Paperless server: http://172.28.128.4:8000
|
|
|
|
|
|
.. _making-things-a-little-more-permanent:
|
|
|
|
Making Things a Little more Permanent
|
|
-------------------------------------
|
|
|
|
Once you've tested things and are happy with the work flow, you can automate the
|
|
process of starting the webserver and consumer automatically. 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. If you're on a SysV or other
|
|
startup system (like the Vagrant box), then you're currently on your own.
|