solr.rst 2.58 KB
Newer Older
Andri Steiner's avatar
Andri Steiner committed
1
.. index::
2 3
   single: Solr
   :name: solr
Andri Steiner's avatar
Andri Steiner committed
4 5

====
6 7 8
Solr
====

9 10
Solr is fully configured through the `Custom JSON` :ref:`customjson_server`.
You can define your instances through the ``solr::instances`` key.
11

12 13
Instance Name
=============
14

15 16
* the name is taken out of the ``solr::instances`` hash name (see examples below)
* a-z and 0-9 are allowed as instance name
17
* your solr instance is then available under ``solr-<name>.<fqdn>`` (example according to `minimal example <#minimal-example>`__: solr-yourname.server01.example.com)
18

19 20
Instance Options
================
21

22 23
version
-------
24

25 26 27
* desired Solr version
* Docker Hub image
* tested versions
28

29 30
  * ``typo3solr/ext-solr:10.0.1``
  * ``solr:8.5.0``
31

32
.. warning::
33

34 35 36
   Even if you can use other versions available as Docker image as well,
   we did test the images mentioned above only, and cannot guarantee anything
   for other versions. Please contact us if you plan to use other versions.
37

38
.. hint::
39

40 41
   For TYPO3 Solr, you'll find more informations in the
   `TYPO3 Solr Documentation <https://docs.typo3.org/p/apache-solr-for-typo3/solr/master/en-us/Index.html>`__.
42

43 44
htpasswd
--------
45

46 47
* htpasswd hash for basic auth
* username is ``solr-<name>``
48 49

ensure
50
------
51

52 53 54
* ``present`` if this Solr instance should be installed
* ``absent`` if this Solr instance should get removed
* default: ``present``
55

56 57
server_name
-----------
58

59 60
* server name under which this installation is available
* default: ``solr-<name>.<fqdn>``
61

62 63
ssl_acme
--------
64

65 66
* wheter a automatic certificate from Let's Encrypt is assigned
* default: ``true``
67

68 69
ssl_cert
--------
70

71 72
* variable to add your own SSL certificate
* default: empty
73

74 75
ssl_key
--------
76

77 78
* variable to add your own SSL key
* default: empty
79 80

monitoring
81
----------
82

83 84
* wheter this Solr instance is monitored through us
* default: ``true``
85

86 87
Minimal Example
===============
88

89

90
Configuration through `Custom JSON` :ref:`customjson_server`.
91

92
.. code-block:: json
93

94 95 96 97 98 99 100 101
   {
     "solr::instances": {
       "yourname": {
         "version": "typo3solr/ext-solr:10.0.1",
         "htpasswd": "$apr1$LIto7/SK$AMosnNDL63JV.3LAuCk0n1"
       }
     }
   }
102 103


104 105
Full Example
============
106

107
Configuration through `Custom JSON` :ref:`customjson_server`.
108

109
.. code-block:: json
110

111 112 113 114 115 116 117 118 119 120 121 122 123 124
   {
     "solr::instances": {
       "yourname": {
         "ensure": "present",
         "version": "typo3solr/ext-solr:10.0.1",
         "htpasswd": "$apr1$LIto7/SK$AMosnNDL63JV.3LAuCk0n1",
         "server_name": "my-solr-core.example.net",
         "ssl_acme": false,
         "ssl_cert": "your-own-ssl-certificate",
         "ssl_key": "your-own-ssl-key",
         "monitoring": false
       }
     }
   }
125