forked from the-paperless-project/paperless
-
Notifications
You must be signed in to change notification settings - Fork 0
/
docker-compose.env.example
102 lines (84 loc) · 4.06 KB
/
docker-compose.env.example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# Environment variables to set for Paperless
# 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_CONSUMPTION_DIR
# * 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.
#
# NOTE: values in paperless.conf should be wrapped in double quotes, but not in this file
# Example:
# paperless.conf: PAPERLESS_FORGIVING_OCR="true"
# docker-compose.env (this file): PAPERLESS_FORGIVING_OCR=true
# Use this variable to set a timezone for the Paperless Docker containers. If not specified, defaults to UTC.
# TZ=America/Los_Angeles
# 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.
# PAPERLESS_OCR_LANGUAGES=deu ita
# Set Paperless to use SSL for the web interface.
# Enabling this will require ssl.key and ssl.cert files in paperless' data directory.
# PAPERLESS_USE_SSL=false
# You can change the default user and group id to a custom one
# USERMAP_UID=1000
# USERMAP_GID=1000
# Environment variables to set for Paperless
# 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_CONSUMPTION_DIR
# * 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.
# 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.
# PAPERLESS_OCR_LANGUAGES=deu ita
# You can change the default user and group id to a custom one
# USERMAP_UID=1000
# USERMAP_GID=1000
# LDAP options
# Uncomment the following line to enable ldap authetication
#PAPERLESS_USE_LDAP=True
# Baseline configuration
#PAPERLESS_AUTH_LDAP_SERVER_URI=ldap://ldap.example.org
#PAPERLESS_AUTH_LDAP_BIND_DN=cn=admin,dc=example,dc=org
#PAPERLESS_AUTH_LDAP_BIND_PASSWORD=<admin_password>
# Enable debug (default false)
#PAPERLESS_AUTH_LDAP_DEBUG=False
# User search filter. Set ...USER_DN to where your user accounts are stored
# and set ...USER_SEARCH_FILTER to the field which matches the user name
# given on django login
#PAPERLESS_AUTH_LDAP_USER_DN=ou=people,dc=example,dc=org
#PAPERLESS_AUTH_LDAP_USER_SEARCH_FILTER=(uid=%(user)s)
# Group search filter. Same as for users but ...GROUP_TYPE has to match
# the ...GROUP_SEARCH_FILTER. For now only groupofnames is implemented.
#PAPERLESS_AUTH_LDAP_GROUP_DN=ou=groups,dc=example,dc=org
#PAPERLESS_AUTH_LDAP_GROUP_SEARCH_FILTER=(objectClass=groupOfNames)
#PAPERLESS_AUTH_LDAP_GROUP_TYPE=groupOfNames
# Get user account permissions from groups. Since paperless uses the admin
# interface, all users need the superuser (su) permission.
# Only relevant for multi user setup and if paperless stops using the admin
# interface.
#PAPERLESS_AUTH_LDAP_GROUP_DN_ACTIVE=cn=django_active,ou=groups,dc=example,dc=org
#PAPERLESS_AUTH_LDAP_GROUP_DN_STAFF=cn=django_staff,ou=groups,dc=example,dc=org
#PAPERLESS_AUTH_LDAP_GROUP_DN_SU=cn=django_su,ou=groups,dc=example,dc=org
# Use StartTLS (default False)
#PAPERLESS_AUTH_LDAP_START_TLS=False
# Simple access permissions through require and deny groups. All users
# in require have access, all users in deny are not allowed access.
# Only relevant for multi user setup.
#PAPERLESS_AUTH_LDAP_REQUIRE_GROUP=cn=django_required,ou=groups,dc=example,dc=org
#PAPERLESS_AUTH_LDAP_DENY_GROUP=cn=django_deny,ou=groups,dc=example,dc=org
# Cache distinguished names and group memberships for this amount of time
# to reduce LDAP traffic. Default is 0 (do not cache at all).
#PAPERLESS_AUTH_LDAP_CACHE_TIMEOUT=0