From 2b686cdb9e363c7c2747ca250ab9bfdc1354ed37 Mon Sep 17 00:00:00 2001
From: Stonewall Jackson <stonewall@sacredheartsc.com>
Date: Mon, 20 Feb 2023 12:39:00 -0500
Subject: solr: add docs

---
 roles/solr/README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 roles/solr/README.md

(limited to 'roles/solr')

diff --git a/roles/solr/README.md b/roles/solr/README.md
new file mode 100644
index 0000000..f834fd8
--- /dev/null
+++ b/roles/solr/README.md
@@ -0,0 +1,25 @@
+Solr
+====
+
+Description
+-----------
+
+The `solr` role installs and configures [Apache Solr](https://solr.apache.org/),
+an open source search platform.
+
+This role is a meta dependency for [dovecot](../dovecot/), and is used to
+provide full-text IMAP search.
+
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable              | Default                           | Description
+----------------------|-----------------------------------|------------
+`solr_version`        | see [defaults](defaults/main.yml) | Solr version to install
+`solr_lucene_version` | see [defaults](defaults/main.yml) | Lucene compatibility version
+`solr_port`           | 8983                              | Local listening port
+`solr_heap_size`      | `2g`                              | Java heap size limit
+`solr_softcommit_ms`  | 60000                             | Automatic softcommit interval (ms)
-- 
cgit