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

adjustments to setup

Browse Source
This commit is contained in:
Jonas Winkler 2021-02-01 21:43:50 +01:00
parent 48b042bfb0
commit 0a28ccf62f
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/setup.rst
View File

@ -151,13 +151,16 @@ Install Paperless from Docker Hub
.. code:: .. code::
- /home/jonaswinkler/paperless-inbox:/usr/src/paperless/consume - /home/jonaswinkler/paperless-inbox:/usr/src/paperless/consume
Don't change the part after the colon or paperless wont find your documents. Don't change the part after the colon or paperless wont find your documents.
5. Modify ``docker-compose.env``, following the comments in the file. The 5. Modify ``docker-compose.env``, following the comments in the file. The
most important change is to set ``USERMAP_UID`` and ``USERMAP_GID`` most important change is to set ``USERMAP_UID`` and ``USERMAP_GID``
to the uid and gid of your user on the host system. This ensures that to the uid and gid of your user on the host system. Use ``id -u`` and
``id -g`` to get these.
This ensures that
both the docker container and you on the host machine have write access both the docker container and you on the host machine have write access
to the consumption directory. If your UID and GID on the host system is to the consumption directory. If your UID and GID on the host system is
1000 (the default for the first normal user on most systems), it will 1000 (the default for the first normal user on most systems), it will
@ -175,15 +178,11 @@ 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
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.
7. Run ``docker-compose up -d``. This will create and start the necessary 6. Run ``docker-compose up -d``. This will pull the image, create and start the necessary
containers, but your are not done yet! containers.
8. 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
following command: following command:
.. code-block:: shell-session .. code-block:: shell-session
@ -193,8 +192,8 @@ Install Paperless from Docker Hub
This will prompt you to set a username, an optional e-mail address and This will prompt you to set a username, an optional e-mail address and
finally a password (at least 8 characters). finally a password (at least 8 characters).
9. 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 did not change 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.