2020-10-29 00:46:57 +01:00
|
|
|
PAPERLESS_DBENGINE="django.db.backends.postgresql_psycopg2"
|
|
|
|
|
PAPERLESS_DBHOST="db"
|
|
|
|
|
PAPERLESS_DBNAME="paperless"
|
|
|
|
|
PAPERLESS_DBUSER="paperless"
|
|
|
|
|
PAPERLESS_DBPASS="paperless"
|
|
|
|
|
|
|
|
|
|
PAPERLESS_CONSUMPTION_DIR="../consume"
|
|
|
|
|
|
Add Dockerfile for application and documentation
This commit adds a `Dockerfile` to the root of the project, accompanied
by a `docker-compose.yml.example` for simplified deployment. The
`Dockerfile` is agnostic to whether it will be the webserver, the
consumer, or if it is run for a one-off command (i.e. creation of a
superuser, migration of the database, document export, ...).
The containers entrypoint is the `scripts/docker-entrypoint.sh` script.
This script verifies that the required permissions are set, remaps the
default users and/or groups id if required and installs additional
languages if the user wishes to.
After initialization, it analyzes the command the user supplied:
- If the command starts with a slash, it is expected that the user
wants to execute a binary file and the command will be executed
without further intervention. (Using `exec` to effectively replace
the started shell-script and not have any reaping-issues.)
- If the command does not start with a slash, the command will be
passed directly to the `manage.py` script without further
modification. (Again using `exec`.)
The default command is set to `--help`.
If the user wants to execute a command that is not meant for `manage.py`
but doesn't start with a slash, the Docker `--entrypoint` parameter can
be used to circumvent the mechanics of `docker-entrypoint.sh`.
Further information can be found in `docs/setup.rst` and in
`docs/migrating.rst`.
For additional convenience, a `Dockerfile` has been added to the `docs/`
directory which allows for easy building and serving of the
documentation. This is documented in `docs/requirements.rst`.
2016-02-17 18:45:04 +01:00
|
|
|
# Environment variables to set for Paperless
|
2018-09-22 15:27:22 +01:00
|
|
|
# Commented out variables will be replaced with a default within Paperless.
|
|
|
|
|
#
|
|
|
|
|
# In addition to what you see here, you can also define any values you find in
|
|
|
|
|
# paperless.conf.example here. Values like:
|
|
|
|
|
#
|
|
|
|
|
# * PAPERLESS_PASSPHRASE
|
|
|
|
|
# * PAPERLESS_CONSUME_MAIL_HOST
|
|
|
|
|
#
|
|
|
|
|
# ...are all explained in that file but can be defined here, since the Docker
|
|
|
|
|
# installation doesn't make use of paperless.conf.
|
|
|
|
|
|
2020-02-17 21:48:39 -08:00
|
|
|
# Use this variable to set a timezone for the Paperless Docker containers. If not specified, defaults to UTC.
|
2020-10-29 00:46:57 +01:00
|
|
|
#TZ=America/Los_Angeles
|
2018-09-22 15:27:22 +01:00
|
|
|
|
|
|
|
|
# Additional languages to install for text recognition. Note that this is
|
|
|
|
|
# different from PAPERLESS_OCR_LANGUAGE (default=eng), which defines the
|
|
|
|
|
# default language used when guessing the language from the OCR output.
|
2020-10-29 00:46:57 +01:00
|
|
|
# The container installs English, German, Italian, Spanish and French by
|
|
|
|
|
# default.
|
|
|
|
|
#PAPERLESS_OCR_LANGUAGES=deu ita spa fra
|
Add Dockerfile for application and documentation
This commit adds a `Dockerfile` to the root of the project, accompanied
by a `docker-compose.yml.example` for simplified deployment. The
`Dockerfile` is agnostic to whether it will be the webserver, the
consumer, or if it is run for a one-off command (i.e. creation of a
superuser, migration of the database, document export, ...).
The containers entrypoint is the `scripts/docker-entrypoint.sh` script.
This script verifies that the required permissions are set, remaps the
default users and/or groups id if required and installs additional
languages if the user wishes to.
After initialization, it analyzes the command the user supplied:
- If the command starts with a slash, it is expected that the user
wants to execute a binary file and the command will be executed
without further intervention. (Using `exec` to effectively replace
the started shell-script and not have any reaping-issues.)
- If the command does not start with a slash, the command will be
passed directly to the `manage.py` script without further
modification. (Again using `exec`.)
The default command is set to `--help`.
If the user wants to execute a command that is not meant for `manage.py`
but doesn't start with a slash, the Docker `--entrypoint` parameter can
be used to circumvent the mechanics of `docker-entrypoint.sh`.
Further information can be found in `docs/setup.rst` and in
`docs/migrating.rst`.
For additional convenience, a `Dockerfile` has been added to the `docs/`
directory which allows for easy building and serving of the
documentation. This is documented in `docs/requirements.rst`.
2016-02-17 18:45:04 +01:00
|
|
|
|
2020-10-29 00:46:57 +01:00
|
|
|
# The UID and GID of the user used to run paperless in the container. Set this
|
|
|
|
|
# to your UID and GID on the host so that you have write access to the
|
|
|
|
|
# consumption directory.
|
|
|
|
|
#USERMAP_UID=1000
|
|
|
|
|
#USERMAP_GID=1000
|
