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
|
|
|
|
|
# Commented out variables will be replaced by a default within Paperless.
|
|
|
|
|
|
|
|
|
|
# Passphrase Paperless uses to encrypt and decrypt your documents
|
|
|
|
|
PAPERLESS_PASSPHRASE=CHANGE_ME
|
|
|
|
|
|
|
|
|
|
# The amount of threads to use for text recognition
|
|
|
|
|
# PAPERLESS_OCR_THREADS=4
|
|
|
|
|
|
|
|
|
|
# Additional languages to install for text recognition
|
|
|
|
|
# PAPERLESS_OCR_LANGUAGES=deu ita
|
|
|
|
|
|
|
|
|
|
# You can change the default user and group id to a custom one
|
|
|
|
|
# USERMAP_UID=1000
|
|
|
|
|
# USERMAP_GID=1000
|
2018-06-15 15:31:29 +02:00
|
|
|
|
|
|
|
|
###############################################################################
|
|
|
|
|
#### Mail Consumption ####
|
|
|
|
|
###############################################################################
|
|
|
|
|
|
|
|
|
|
# These values are required if you want paperless to check a particular email
|
|
|
|
|
# box every 10 minutes and attempt to consume documents from there. If you
|
|
|
|
|
# don't define a HOST, mail checking will just be disabled.
|
2018-06-15 14:44:19 +01:00
|
|
|
# Don't use quotes after = or it will crash your docker
|
2018-06-15 15:31:29 +02:00
|
|
|
# PAPERLESS_CONSUME_MAIL_HOST=
|
|
|
|
|
# PAPERLESS_CONSUME_MAIL_PORT=
|
|
|
|
|
# PAPERLESS_CONSUME_MAIL_USER=
|
|
|
|
|
# PAPERLESS_CONSUME_MAIL_PASS=
|
|
|
|
|
|
2018-06-15 14:44:19 +01:00
|
|
|
# Override the default IMAP inbox here. If it's not set, Paperless defaults to
|
2018-06-15 15:31:29 +02:00
|
|
|
# INBOX.
|
|
|
|
|
# PAPERLESS_CONSUME_MAIL_INBOX=INBOX
|
|
|
|
|
|
|
|
|
|
# Any email sent to the target account that does not contain this text will be
|
2018-06-15 14:44:19 +01:00
|
|
|
# ignored. Mail checking won't work without this.
|
2018-06-15 15:31:29 +02:00
|
|
|
# PAPERLESS_EMAIL_SECRET=
|
2018-06-15 14:44:19 +01:00
|
|
|
|
