more documentation.

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

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.