aboutsummaryrefslogtreecommitdiffstats
path: root/roles/tika
diff options
context:
space:
mode:
authorStonewall Jackson <stonewall@sacredheartsc.com>2023-02-20 20:43:13 -0500
committerStonewall Jackson <stonewall@sacredheartsc.com>2023-02-20 20:43:13 -0500
commit73b9f37fa88251108e9de95e51aaf2a9a1b39da6 (patch)
treea6bf0327082c95e594e4ffed83d802ead0ecaa1f /roles/tika
parent23b96f0f63a6e5b6389d588268e76b71660678a8 (diff)
downloadselfhosted-73b9f37fa88251108e9de95e51aaf2a9a1b39da6.tar.gz
selfhosted-73b9f37fa88251108e9de95e51aaf2a9a1b39da6.zip
tika: add docs
Diffstat (limited to 'roles/tika')
-rw-r--r--roles/tika/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/roles/tika/README.md b/roles/tika/README.md
new file mode 100644
index 0000000..747a24d
--- /dev/null
+++ b/roles/tika/README.md
@@ -0,0 +1,23 @@
+Tika
+====
+
+Description
+-----------
+
+The `tika` role installs and configures [Apache Tika](https://tika.apache.org/),
+an open source document analysis platform.
+
+This role is a meta dependency for [dovecot](../dovecot/), and is used to
+index attachments for full-text IMAP search.
+
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable | Default | Description
+----------------------|-----------------------------------|------------
+`tika_version` | see [defaults](defaults/main.yml) | Tika version to install
+`tika_port` | 9998 | Local listening port
+`tika_heap_size` | `2g` | Java heap size limit