aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStonewall Jackson <stonewall@sacredheartsc.com>2023-02-20 12:39:00 -0500
committerStonewall Jackson <stonewall@sacredheartsc.com>2023-02-20 12:39:00 -0500
commit2b686cdb9e363c7c2747ca250ab9bfdc1354ed37 (patch)
treed52fa183ad59a340020b31e892ccdd684dfb2c11
parentb899d9451dd6f9bc4c2c0b58d6972d3c77dd5d7b (diff)
downloadselfhosted-2b686cdb9e363c7c2747ca250ab9bfdc1354ed37.tar.gz
selfhosted-2b686cdb9e363c7c2747ca250ab9bfdc1354ed37.zip
solr: add docs
-rw-r--r--roles/solr/README.md25
1 files changed, 25 insertions, 0 deletions
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)