paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-04-02 13:45:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Support SSL for web interface

Browse Source 
Thanks to @MasterofJOKers, here is basic support for SSL:
You need to create your key and certificate and copy them to the `data`
directory, named `ssl.cert` and `ssl.key`.
Then, set `PAPERLESS_USE_SSL` in `docker-compose.env` to `true`.

Solves #576.
This commit is contained in:
Fabian Winter 2019-11-03 18:24:03 +01:00
parent a690b1cf24
commit 9b2b435c5b
3 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docker-compose.env.example
View File

@ -16,6 +16,7 @@
# different from PAPERLESS_OCR_LANGUAGE (default=eng), which defines the # different from PAPERLESS_OCR_LANGUAGE (default=eng), which defines the
# default language used when guessing the language from the OCR output. # default language used when guessing the language from the OCR output.
# PAPERLESS_OCR_LANGUAGES=deu ita # PAPERLESS_OCR_LANGUAGES=deu ita
# PAPERLESS_USE_SSL=false
# You can change the default user and group id to a custom one # You can change the default user and group id to a custom one
# USERMAP_UID=1000 # USERMAP_UID=1000

8
docs/setup.rst
View File

@ -193,6 +193,11 @@ Docker Method
container and thus the one of the consumption directory. Furthermore, you container and thus the one of the consumption directory. Furthermore, you
can change the id of the default user as well using ``USERMAP_UID``. can change the id of the default user as well using ``USERMAP_UID``.
``USE_SSL``
If you want Paperless to use SSL for the user interface, set this variable
to ``true``. You also need to copy your certificate and key to the ``data``
directory, named ``ssl.cert`` and ``ssl.key``.
6. Run ``docker-compose up -d``. This will create and start the necessary 6. Run ``docker-compose up -d``. This will create and start the necessary
containers. containers.
7. To be able to login, you will need a super user. To create it, execute the 7. To be able to login, you will need a super user. To create it, execute the
@ -206,7 +211,8 @@ Docker Method
e-mail address and finally a password. e-mail address and finally a password.
8. The default ``docker-compose.yml`` exports the webserver on your local port 8. The default ``docker-compose.yml`` exports the webserver on your local port
8000. If you haven't adapted this, you should now be able to visit your 8000. If you haven't adapted this, you should now be able to visit your
`Paperless webserver`_ at ``http://127.0.0.1:8000``. You can login with the `Paperless webserver`_ at ``http://127.0.0.1:8000`` (or
``https://127.0.0.1:8000`` if you enabled SSL). You can login with the
user and password you just created. user and password you just created.
9. Add files to consumption directory the way you prefer to. Following are two 9. Add files to consumption directory the way you prefer to. Following are two
possible options: possible options:

8
scripts/docker-entrypoint.sh
View File

@ -101,8 +101,14 @@ if [[ "$1" != "/"* ]]; then
if [[ "$1" = "gunicorn" ]]; then if [[ "$1" = "gunicorn" ]]; then
shift shift
EXTRA_PARAMS=""
SSL_KEY_PATH="/usr/src/paperless/data/ssl.key"
SSL_CERT_PATH="/usr/src/paperless/data/ssl.cert"
if [ "${PAPERLESS_USE_SSL}" = "true" ] && [ -f "${SSL_KEY_PATH}" ] && [ -f "${SSL_CERT_PATH}" ]; then
EXTRA_PARAMS="--certfile=${SSL_CERT_PATH} --keyfile=${SSL_KEY_PATH}"
fi
cd /usr/src/paperless/src/ && \ cd /usr/src/paperless/src/ && \
exec sudo -HEu paperless /usr/bin/gunicorn -c /usr/src/paperless/gunicorn.conf "$@" paperless.wsgi exec sudo -HEu paperless /usr/bin/gunicorn -c /usr/src/paperless/gunicorn.conf ${EXTRA_PARAMS} "$@" paperless.wsgi
else else
exec sudo -HEu paperless "/usr/src/paperless/src/manage.py" "$@" exec sudo -HEu paperless "/usr/src/paperless/src/manage.py" "$@"
fi fi