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

moved gunicorn.conf.py to a more appropriate place and reference that in the configuration scripts.

Browse Source
This commit is contained in:
jonaswinkler 2021-01-31 13:52:21 +01:00
parent 4e2efebaa7
commit adb76eafaf
5 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.github/workflows/ci.yml vendored
View File

@ -155,6 +155,7 @@ jobs:
mkdir dist/paperless-ng/scripts mkdir dist/paperless-ng/scripts
cp .dockerignore .env Dockerfile Pipfile Pipfile.lock LICENSE README.md requirements.txt dist/paperless-ng/ cp .dockerignore .env Dockerfile Pipfile Pipfile.lock LICENSE README.md requirements.txt dist/paperless-ng/
cp paperless.conf.example dist/paperless-ng/paperless.conf cp paperless.conf.example dist/paperless-ng/paperless.conf
cp gunicorn.conf.py dist/paperless-ng/gunicorn.conf.py
cp docker/ dist/paperless-ng/docker -r cp docker/ dist/paperless-ng/docker -r
cp scripts/*.service scripts/*.sh dist/paperless-ng/scripts/ cp scripts/*.service scripts/*.sh dist/paperless-ng/scripts/
cp src/ dist/paperless-ng/src -r cp src/ dist/paperless-ng/src -r

3
Dockerfile
View File

@ -77,7 +77,8 @@ RUN apt-get update \
# copy scripts # copy scripts
# this fixes issues with imagemagick and PDF # this fixes issues with imagemagick and PDF
COPY docker/imagemagick-policy.xml /etc/ImageMagick-6/policy.xml COPY docker/imagemagick-policy.xml /etc/ImageMagick-6/policy.xml
COPY docker/gunicorn.conf.py ./
COPY gunicorn.conf.py ./
COPY docker/supervisord.conf /etc/supervisord.conf COPY docker/supervisord.conf /etc/supervisord.conf
COPY docker/docker-entrypoint.sh /sbin/docker-entrypoint.sh COPY docker/docker-entrypoint.sh /sbin/docker-entrypoint.sh

16
docs/setup.rst
View File

@ -20,7 +20,7 @@ Paperless consists of the following components:
.. code:: shell-session .. code:: shell-session
$ cd /path/to/paperless/src/ $ cd /path/to/paperless/src/
$ gunicorn -c ../gunicorn.conf.py -b 0.0.0.0:8000 paperless.wsgi $ gunicorn -c ../gunicorn.conf.py paperless.wsgi
or by any other means such as Apache ``mod_wsgi``. or by any other means such as Apache ``mod_wsgi``.
@ -88,7 +88,7 @@ You can go multiple routes to setup and run Paperless:
The Docker routes are quick & easy. These are the recommended routes. This configures all the stuff The Docker routes are quick & easy. These are the recommended routes. This configures all the stuff
from the above automatically so that it just works and uses sensible defaults for all configuration options. from the above automatically so that it just works and uses sensible defaults for all configuration options.
Here you find a cheat-sheet for docker beginners: `CLI Basics <https://sehn.tech/post/devops-with-docker/>`_ Here you find a cheat-sheet for docker beginners: `CLI Basics <https://sehn.tech/post/devops-with-docker/>`_
The bare metal route is complicated to setup but makes it easier The bare metal route is complicated to setup but makes it easier
should you want to contribute some code back. You need to configure and should you want to contribute some code back. You need to configure and
@ -126,7 +126,7 @@ Install Paperless from Docker Hub
If you want to use the included ``docker-compose.*.yml`` file, you If you want to use the included ``docker-compose.*.yml`` file, you
need to have at least Docker version **17.09.0** and docker-compose need to have at least Docker version **17.09.0** and docker-compose
version **1.17.0**. version **1.17.0**.
To check do: `docker-compose -v` or `docker -v` To check do: `docker-compose -v` or `docker -v`
See the `Docker installation guide`_ on how to install the current See the `Docker installation guide`_ on how to install the current
@ -175,7 +175,7 @@ Install Paperless from Docker Hub
on such a file system, paperless will not pick up new files on such a file system, paperless will not pick up new files
with the default configuration. You will need to use ``PAPERLESS_CONSUMER_POLLING``, with the default configuration. You will need to use ``PAPERLESS_CONSUMER_POLLING``,
which will disable inotify. See :ref:`here <configuration-polling>`. which will disable inotify. See :ref:`here <configuration-polling>`.
6. Now head over to: https://hub.docker.com/r/jonaswinkler/paperless-ng and choose your preferred 6. Now head over to: https://hub.docker.com/r/jonaswinkler/paperless-ng and choose your preferred
image and copy the link. To download this image do a `docker pull` followed by the link. Do this within the directory with the .yml files. image and copy the link. To download this image do a `docker pull` followed by the link. Do this within the directory with the .yml files.
Depending on your network connection and CPU this will take a while. You have time to get a beverage. Depending on your network connection and CPU this will take a while. You have time to get a beverage.
@ -195,7 +195,7 @@ Install Paperless from Docker Hub
9. The default ``docker-compose.yml`` exports the webserver on your local port 9. 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 instance at ``http://127.0.0.1:8000`` or your servers IP-Address:8000. Paperless instance at ``http://127.0.0.1:8000`` or your servers IP-Address:8000.
Use the login credentials you have created with the previous step. Use the login credentials you have created with the previous step.
.. _Docker: https://www.docker.com/ .. _Docker: https://www.docker.com/
@ -224,7 +224,7 @@ Build the docker image yourself
webserver: webserver:
image: jonaswinkler/paperless-ng:latest image: jonaswinkler/paperless-ng:latest
and replace it with a line that instructs docker-compose to build the image from the current working directory instead: and replace it with a line that instructs docker-compose to build the image from the current working directory instead:
.. code:: yaml .. code:: yaml
@ -427,7 +427,7 @@ Install Paperless using ansible
This role currently only supports Debian 10 Buster and Ubuntu 20.04 Focal or later as target hosts. This role currently only supports Debian 10 Buster and Ubuntu 20.04 Focal or later as target hosts.
1. Install ansible 2.7+ on the management node. 1. Install ansible 2.7+ on the management node.
This may be the target host paperless-ng is being installed on or any remote host which can access the target host. This may be the target host paperless-ng is being installed on or any remote host which can access the target host.
For further details, check the ansible `inventory <https://docs.ansible.com/ansible/latest/user_guide/intro_inventory.html>`_ documentation. For further details, check the ansible `inventory <https://docs.ansible.com/ansible/latest/user_guide/intro_inventory.html>`_ documentation.
@ -585,7 +585,7 @@ Migration to paperless-ng is then performed in a few simple steps:
.. code:: shell-session .. code:: shell-session
$ docker volume ls | grep _data $ docker volume ls | grep _data
and adjust the project name in the ``.env`` file so that it matches the name and adjust the project name in the ``.env`` file so that it matches the name
of the volumes before the ``_data`` part. of the volumes before the ``_data`` part.

0
docker/gunicorn.conf.py → gunicorn.conf.py
View File

2
scripts/paperless-webserver.service
View File

@ -8,7 +8,7 @@ Requires=redis.service
User=paperless User=paperless
Group=paperless Group=paperless
WorkingDirectory=/opt/paperless/src WorkingDirectory=/opt/paperless/src
ExecStart=/opt/paperless/.local/bin/gunicorn paperless.wsgi -w 2 -b 0.0.0.0:8000 ExecStart=/opt/paperless/.local/bin/gunicorn -c /opt/paperless/gunicorn.conf.py paperless.wsgi
[Install] [Install]
WantedBy=multi-user.target WantedBy=multi-user.target