Status	Wydarzenie
	Harmonogram tygodniowy
	Ostatnie PR

Rola Ansible: paperless_ngx

Instaluje i konfiguruje system zarządzania dokumentami paperless-ngx.

1. Wymagania

1.1. Ansible

Wymagana jest wersja ansible_version_minimum: "2.12" lub nowsza.

Następujące zbiory Ansible muszą być zainstalowane (przez ansible-galaxy collection install):

• community.general
• ansible.posix

1.2. Obsługiwane systemy operacyjne

• Debian (>=11)
• Ubuntu (>=focal)

2. Zmienne roli

Większość zmiennych konfiguracyjnych z samego paperless-ngx jest dostępna i akceptuje swoje odpowiednie argumenty. Każda zmienna konfiguracyjna PAPERLESS_* jest zapisywana małymi literami i poprzedzona prefiksem paperless_ngx_conf_* w defaults/main.yml.

Zobacz aktualną dokumentację dla pełnej listy z wyjaśnieniami i dozwolonymi wartościami.

2.1. Zmienna specyficzna dla roli

Nazwa	Wartość domyślna	Opis
paperless_ngx_db_type	sqlite	Dostępne typy baz danych: sqlite i postgresql. Jeśli wybrano postgresql, muszą być również skonfigurowane pozostałe zmienne dotyczące bazy danych.
paperless_ngx_dependency_install_tmp_dir	/tmp/	Katalog dla tymczasowych plików instalacyjnych zależności
paperless_ngx_dir_force_permission_exclude	[]	Które katalogi powinny być pominięte podczas sprawdzania/ustawiania uprawnień. Zobacz dokumentację.
paperless_ngx_dir_installation	/opt/paperless-ngx	Katalog, w którym zapisywane są statyczne pliki instalacyjne paperless-ngx.
paperless_ngx_dir_python	/opt/python/{{ paperless_ngx_python_version_short }}	Katalog, w którym kompilowane są pliki binarne Pythona.
paperless_ngx_dir_runtime_data	/var/lib/paperless-ngx	Katalog, w którym będą przechowywane dane w czasie rzeczywistym.
paperless_ngx_dir_virtualenv	"{{ paperless_ngx_dir_installation }}/.venv"	Katalog dla potrzebnego wirtualnego środowiska Pythona.
paperless_ngx_version	latest	Wersja oprogramowania do zainstalowania. Użyj latest lub podaj konkretną wersję w formacie '2.0.0'. Wspierane są tylko wersje paperless_ngx_version_minimum: '2.0.0' i nowsze.

2.2. Zmienna konfiguracyjna Paperless-ngx

Wszystkie nadchodzące zmienne odpowiadają zmiennym z dokumentacji paperless-ngx. Lista jest uporządkowana alfabetycznie, aby ułatwić zarządzanie tą rolą.

Nazwa	Wartość domyślna	I	O	H	V
paperless_ngx_conf_account_allow_signups	false	Y	Y		2.5
paperless_ngx_conf_account_default_http_protocol	https	Y	Y		2.5
paperless_ngx_conf_admin_mail	root@localhost	Y	Y
paperless_ngx_conf_admin_password		Y	Y	Hasło superużytkownika. Jeśli nie zdefiniowane przez użytkownika, wygenerowane zostanie losowe hasło.
paperless_ngx_conf_allowed_hosts	"*"	Y	Y
paperless_ngx_conf_enable_update_check		Y	Y	Będzie usunięte w przyszłości

3. Porady dotyczące użycia

3.1. Aktualizacja Paperless-ngx

Jeśli zainstalowałeś Paperless-ngx za pomocą tej roli i chcesz zaktualizować do nowszej wersji, wystarczy ponownie uruchomić tę rolę (jeśli wybrałeś latest jako identyfikator wersji). Jeśli określiłeś konkretną wersję do zainstalowania, wystarczy zmienić tę wartość na nowszą i ponownie uruchomić rolę.

3.2. Kopia zapasowa/Odzyskiwanie

Proszę pamiętać, że ta rola nie oferuje żadnego mechanizmu tworzenia kopii zapasowych ani odzyskiwania. Celem tej roli jest jedynie „wdrożenie” artefaktów oprogramowania i ich konfiguracji.

3.3. Wygenerowane hasło

Rola używa funkcji wyszukiwania haseł Ansible.

3.4. Separacja danych statycznych i dynamicznych

Ta rola sprawdza, czy nie ustawiasz jednego z katalogów danych (np. konsumpcji) jako podkatalogu ścieżki instalacji.

3.5. Użycie PostgreSQL

Jeśli chcesz korzystać z Paperless-ngx z PostgreSQL, potrzebujesz działającej instancji PostgreSQL. Ten skrypt nie instaluje automatycznie takiej instancji.

4. Zależności

Brak zależności.

5. Przykładowe Playbooki

minimal_runnable_playbook.yml:

- hosts: all
    roles:
        - { role: paperless_ngx.paperless_ngx }
    vars:
        var1:
        var2:
        ...

6. Współpraca

Zachęcamy do współpracy w tej roli! Prosimy o zapoznanie się z przewodnikiem po współpracy w celu uzyskania wskazówek, jak postępować.

7. Licencja

MIT