paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-05-01 11:19:32 -05:00
Code Issues Packages Projects Releases Wiki Activity

Apply consistent name structure to vars

Browse Source
This commit is contained in:
Fabian Koller 2021-02-03 07:53:49 +01:00
parent 66b18266b8
commit 7d2666148e
4 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ansible/README.md
View File

@ -107,7 +107,7 @@ Example Playbook
paperlessng_db_type: postgresql paperlessng_db_type: postgresql
paperlessng_db_pass: PLEASEPROVIDEASTRONGPASSWORDHERE paperlessng_db_pass: PLEASEPROVIDEASTRONGPASSWORDHERE
paperless_secret_key: AGAINPLEASECHANGETHISNOW paperlessng_secret_key: AGAINPLEASECHANGETHISNOW
paperlessng_ocr_languages: paperlessng_ocr_languages:
- eng - eng

16
ansible/defaults/main.yml
View File

@ -23,14 +23,14 @@ paperlessng_filename_format:
paperlessng_virtualenv: "{{ paperlessng_directory }}/.venv" paperlessng_virtualenv: "{{ paperlessng_directory }}/.venv"
# Hosting & Security # Hosting & Security
paperless_secret_key: PLEASECHANGETHISFORTHELOVEOFGOD paperlessng_secret_key: PLEASECHANGETHISFORTHELOVEOFGOD
paperless_allowed_hosts: "*" paperlessng_allowed_hosts: "*"
paperless_cors_allowed_hosts: http://localhost:8000 paperlessng_cors_allowed_hosts: http://localhost:8000
paperless_force_script_name: paperlessng_force_script_name:
paperless_static_url: /static/ paperlessng_static_url: /static/
paperless_auto_login_username: paperlessng_auto_login_username:
paperless_cookie_prefix: "" paperlessng_cookie_prefix: ""
paperless_enable_http_remote_user: False paperlessng_enable_http_remote_user: False
# OCR settings # OCR settings
paperlessng_ocr_languages: paperlessng_ocr_languages:

16
ansible/tasks/main.yml
View File

@ -286,21 +286,21 @@
line: "PAPERLESS_FILENAME_FORMAT={{ paperlessng_filename_format }}" line: "PAPERLESS_FILENAME_FORMAT={{ paperlessng_filename_format }}"
# Hosting & Security # Hosting & Security
- regexp: PAPERLESS_SECRET_KEY - regexp: PAPERLESS_SECRET_KEY
line: "PAPERLESS_SECRET_KEY={{ paperless_secret_key }}" line: "PAPERLESS_SECRET_KEY={{ paperlessng_secret_key }}"
- regexp: PAPERLESS_ALLOWED_HOSTS - regexp: PAPERLESS_ALLOWED_HOSTS
line: "PAPERLESS_ALLOWED_HOSTS={{ paperless_allowed_hosts }}" line: "PAPERLESS_ALLOWED_HOSTS={{ paperlessng_allowed_hosts }}"
- regexp: PAPERLESS_CORS_ALLOWED_HOSTS - regexp: PAPERLESS_CORS_ALLOWED_HOSTS
line: "PAPERLESS_CORS_ALLOWED_HOSTS={{ paperless_cors_allowed_hosts }}" line: "PAPERLESS_CORS_ALLOWED_HOSTS={{ paperlessng_cors_allowed_hosts }}"
- regexp: PAPERLESS_FORCE_SCRIPT_NAME - regexp: PAPERLESS_FORCE_SCRIPT_NAME
line: "PAPERLESS_FORCE_SCRIPT_NAME={{ paperless_force_script_name }}" line: "PAPERLESS_FORCE_SCRIPT_NAME={{ paperlessng_force_script_name }}"
- regexp: PAPERLESS_STATIC_URL - regexp: PAPERLESS_STATIC_URL
line: "PAPERLESS_STATIC_URL={{ paperless_static_url }}" line: "PAPERLESS_STATIC_URL={{ paperlessng_static_url }}"
- regexp: PAPERLESS_AUTO_LOGIN_USERNAME - regexp: PAPERLESS_AUTO_LOGIN_USERNAME
line: "PAPERLESS_AUTO_LOGIN_USERNAME={{ paperless_auto_login_username }}" line: "PAPERLESS_AUTO_LOGIN_USERNAME={{ paperlessng_auto_login_username }}"
- regexp: PAPERLESS_COOKIE_PREFIX - regexp: PAPERLESS_COOKIE_PREFIX
line: "PAPERLESS_COOKIE_PREFIX={{ paperless_cookie_prefix }}" line: "PAPERLESS_COOKIE_PREFIX={{ paperlessng_cookie_prefix }}"
- regexp: PAPERLESS_ENABLE_HTTP_REMOTE_USER - regexp: PAPERLESS_ENABLE_HTTP_REMOTE_USER
line: "PAPERLESS_ENABLE_HTTP_REMOTE_USER={{ paperless_enable_http_remote_user }}" line: "PAPERLESS_ENABLE_HTTP_REMOTE_USER={{ paperlessng_enable_http_remote_user }}"
# OCR settings # OCR settings
- regexp: PAPERLESS_OCR_LANGUAGE - regexp: PAPERLESS_OCR_LANGUAGE
line: "PAPERLESS_OCR_LANGUAGE={{ paperlessng_ocr_languages | join('+') }}" line: "PAPERLESS_OCR_LANGUAGE={{ paperlessng_ocr_languages | join('+') }}"

20
docs/setup.rst
View File

@ -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
@ -151,7 +151,7 @@ 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.
@ -159,7 +159,7 @@ Install Paperless from Docker Hub
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. Use ``id -u`` and to the uid and gid of your user on the host system. Use ``id -u`` and
``id -g`` to get these. ``id -g`` to get these.
This ensures that 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
@ -194,7 +194,7 @@ Install Paperless from Docker Hub
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 did not change 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.
.. _Docker: https://www.docker.com/ .. _Docker: https://www.docker.com/
@ -223,7 +223,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
@ -426,7 +426,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.
@ -461,7 +461,7 @@ Install Paperless using ansible
.. code:: sh .. code:: sh
cd paperless-ng cd paperless-ng
git checkout ng-0.9.14 git checkout ng-1.0.0
3. Create an ansible ``playbook.yml`` in the paperless-ng root directory: 3. Create an ansible ``playbook.yml`` in the paperless-ng root directory:
@ -511,7 +511,7 @@ Install Paperless using ansible
.. code:: yaml .. code:: yaml
paperless_secret_key: PleaseGenerateAStrongKeyForThis paperlessng_secret_key: PleaseGenerateAStrongKeyForThis
paperlessng_superuser_name: YourUserName paperlessng_superuser_name: YourUserName
paperlessng_superuser_email: name@domain.tld paperlessng_superuser_email: name@domain.tld
@ -584,7 +584,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.