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

more documentation.

Browse Source
This commit is contained in:
Jonas Winkler
2020-11-13 20:43:16 +01:00
parent 73a3230494
commit aebcc2b911
3 changed files with 27 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/configuration.rst Normal file
View 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.

1
docs/index.rst
View File

@@ -47,6 +47,7 @@ Contents
usage_overview usage_overview
advanced_usage advanced_usage
administration administration
configuration
api api
extending extending
troubleshooting troubleshooting

5
docs/setup.rst
View File

@@ -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 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 sqlite database, **it will not use your sqlite database and it may seem
as if your documents are gone**. You may use the provided 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 * The task scheduler of paperless, which is used to execute periodic tasks
such as email checking and maintenance, requires a `redis`_ message broker such as email checking and maintenance, requires a `redis`_ message broker
instance. The docker-compose route takes care of that. 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 everything related to paperless in your browsers data in order to fix
this issue. this issue.
.. _setup-sqlite_to_psql:
Moving data from sqlite to postgresql Moving data from sqlite to postgresql
===================================== =====================================