mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2025-04-02 13:45:10 -05:00
more documentation.
This commit is contained in:
parent
73a3230494
commit
aebcc2b911
22
docs/configuration.rst
Normal file
22
docs/configuration.rst
Normal file
@ -0,0 +1,22 @@
|
||||
*************
|
||||
Configuration
|
||||
*************
|
||||
|
||||
Paperless provides a wide range of customizations.
|
||||
Have a look at ``paperless.conf.example`` for available configuration options.
|
||||
Depending on how you run paperless, these settings have to be defined in different
|
||||
places.
|
||||
|
||||
* If you run paperless on docker, ``paperless.conf`` is not used. Rather, configure
|
||||
paperless by copying necessary options to ``docker-compose.env``.
|
||||
* If you are running paperless on anything else, paperless will search for the
|
||||
configuration file in these locations and use the first one it finds:
|
||||
|
||||
.. code::
|
||||
|
||||
/path/to/paperless/paperless.conf
|
||||
/etc/paperless.conf
|
||||
/usr/local/etc/paperless.conf
|
||||
|
||||
Copy ``paperless.conf.example`` to any of these locations and adjust it to your
|
||||
needs.
|
@ -47,6 +47,7 @@ Contents
|
||||
usage_overview
|
||||
advanced_usage
|
||||
administration
|
||||
configuration
|
||||
api
|
||||
extending
|
||||
troubleshooting
|
||||
|
@ -127,7 +127,8 @@ how you installed paperless. The important things to keep in mind are as follows
|
||||
with your current paperless media and data volumes and used the default
|
||||
sqlite database, **it will not use your sqlite database and it may seem
|
||||
as if your documents are gone**. You may use the provided
|
||||
``docker-compose.yml.sqlite.example`` script, which does not use postgresql.
|
||||
``docker-compose.yml.sqlite.example`` script, which does not use postgresql. See
|
||||
:ref:`setup-sqlite_to_psql` for details.
|
||||
* The task scheduler of paperless, which is used to execute periodic tasks
|
||||
such as email checking and maintenance, requires a `redis`_ message broker
|
||||
instance. The docker-compose route takes care of that.
|
||||
@ -177,6 +178,8 @@ Migration to paperless-ng is then performed in a few simple steps:
|
||||
everything related to paperless in your browsers data in order to fix
|
||||
this issue.
|
||||
|
||||
.. _setup-sqlite_to_psql:
|
||||
|
||||
Moving data from sqlite to postgresql
|
||||
=====================================
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user