solr.rst 2.98 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
14
15
16
.. warning::

   Each Solr instance does run within its own Docker container. For persistent data storage, make sure to
   configure your cores with a ``dataDir`` within ``/var/solr/`` as designated in Solr's default configuration.

17
18
Instance Name
=============
19

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

24
25
Instance Options
================
26

27
28
version
-------
29

30
31
* desired Solr version, available on Docker Hub [`1 <https://hub.docker.com/r/typo3solr/ext-solr/tags>`__] [`1 <https://hub.docker.com/_/solr?tab=tags>`__]
* please check if your chosen version is available on docker hub
32
* tested versions
33

34
35
  * ``typo3solr/ext-solr:10.0.1``
  * ``solr:8.5.0``
36

37
.. warning::
38

39
40
41
   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.
42

43
.. hint::
44

45
46
   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>`__.
47

48
49
htpasswd
--------
50

51
52
* htpasswd hash for basic auth
* username is ``solr-<name>``
53
54

ensure
55
------
56

57
58
59
* ``present`` if this Solr instance should be installed
* ``absent`` if this Solr instance should get removed
* default: ``present``
60

61
62
server_name
-----------
63

64
65
* server name under which this installation is available
* default: ``solr-<name>.<fqdn>``
66

67
68
ssl_acme
--------
69

70
71
* wheter a automatic certificate from Let's Encrypt is assigned
* default: ``true``
72

73
74
ssl_cert
--------
75

76
77
* variable to add your own SSL certificate
* default: empty
78

79
80
ssl_key
--------
81

82
83
* variable to add your own SSL key
* default: empty
84
85

monitoring
86
----------
87

88
89
* wheter this Solr instance is monitored through us
* default: ``true``
90

91
92
Minimal Example
===============
93

94

95
Configuration through `Custom JSON` :ref:`customjson_server`.
96

97
.. code-block:: json
98

99
100
101
102
103
104
105
106
   {
     "solr::instances": {
       "yourname": {
         "version": "typo3solr/ext-solr:10.0.1",
         "htpasswd": "$apr1$LIto7/SK$AMosnNDL63JV.3LAuCk0n1"
       }
     }
   }
107
108


109
110
Full Example
============
111

112
Configuration through `Custom JSON` :ref:`customjson_server`.
113

114
.. code-block:: json
115

116
117
118
119
120
121
122
123
124
125
126
127
128
129
   {
     "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
       }
     }
   }
130