Skip to content
This repository was archived by the owner on Feb 16, 2023. It is now read-only.

Commit 63402b7

Browse files
authored
Merge pull request #1057 from muued/patch-6
adjust ansible README to installation instructions
2 parents b8386a1 + 10bf9fd commit 63402b7

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

ansible/README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,27 +12,29 @@ Note that this role requires root access, so either run it in a playbook with a
1212

1313
- hosts: all
1414
roles:
15-
- role: ansible
15+
- role: paperless-ng
1616
become: yes
1717

1818
Role Variables
1919
--------------
2020

2121
Most configuration variables from paperless-ng itself are available and accept their respective arguments.
22-
Every `PAPERLESS_*` configuration varaible is lowercased and instead prefixed with `paperlessng_*` in `defaults/main.yml`.
22+
Every `PAPERLESS_*` configuration variable is lowercased and instead prefixed with `paperlessng_*` in `defaults/main.yml`.
2323

24-
For a full listing including explainations and allowed values, see the current [documentation](https://paperless-ng.readthedocs.io/en/ng-0.9.14/configuration.html).
24+
For a full listing including explanations and allowed values, see the current [documentation](https://paperless-ng.readthedocs.io/en/latest/configuration.html).
2525

2626
Additional variables available in this role are listed below, along with default values:
2727

28-
paperlessng_version: 0.9.14
28+
paperlessng_version: latest
2929

3030
The [release](https://github.com/jonaswinkler/paperless-ng/releases) archive version of paperless-ng to install.
31+
`latest` stands for the latest release of paperless-ng.
32+
To install a specific version of paperless-ng, use the tag name of the release, e. g. `ng-1.4.4`, or specify a branch or commit id.
3133

3234
paperlessng_redis_host: localhost
3335
paperlessng_redis_port: 6379
3436

35-
Seperate configuration values that combine into `PAPERLESS_REDIS`.
37+
Separate configuration values that combine into `PAPERLESS_REDIS`.
3638

3739
paperlessng_db_type: sqlite
3840

@@ -96,11 +98,11 @@ Example Playbook
9698
- hosts: all
9799
become: yes
98100
vars_files:
99-
- vars/main.yml
101+
- vars/paperless-ng.yml
100102
roles:
101-
- ansible
103+
- paperless-ng
102104

103-
`vars/main.yml`:
105+
`vars/paperless-ng.yml`:
104106

105107
paperlessng_media_root: /mnt/media/smbshare
106108

0 commit comments

Comments
 (0)