| 12
 3
 4
 5
 6
 7
 8
 9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 
 | .. -*- rst -*-
Server packages
===============
The package ``groonga`` is the minimum set of fulltext search engine.
If you want to use groonga for server use, you can install
additional preconfigured packages.
There are three packages for server use.
* :doc:`/reference/executables/groonga-httpd` (nginx and HTTP based server package)
* :doc:`/reference/executables/groonga-server-http` (HTTP based server package)
* ``groonga-server-gqtp`` (:doc:`/spec/gqtp` based server package)
There is the reason why groonga supports not only GQTP but also two HTTP server
packages. :doc:`/spec/gqtp` - Groonga Query Transfer Protocol is desined to reduce overheads
and improve performance. But, GQTP is less support of client library than HTTP protocol does.
As HTTP is matured protocol, you can take advantage of existing tool and there are many client
library (See `related projects <https://groonga.org/related-projects.html>`_ for details).
If you use :doc:`/reference/executables/groonga-httpd` package, you can also take benefits of nginx functionality.
We recommend to use :doc:`/reference/executables/groonga-server-http` at first, because it provides fulfilling server functionality.
If you have performance issues which is derived from protocol overheads, consider to use ``groonga-server-gqtp``.
groonga-httpd
-------------
.. warning::
   groonga-httpd has been extracted as `groonga-nginx
   <https://github.com/groonga/groonga-nginx>`_ since Groonga
   13.0.3.
``groonga-httpd`` is a nginx and HTTP based server package.
Preconfigured setting:
+--------------------+---------------------------------------+
| Item               | Default value                         |
+====================+=======================================+
| Port number        | 10041                                 |
+--------------------+---------------------------------------+
| Access log path    | /var/log/groonga/httpd/acccess.log    |
+--------------------+---------------------------------------+
| Error log path     | /var/log/groonga/http-query.log       |
+--------------------+---------------------------------------+
| Database           | /var/lib/groonga/db/*                 |
+--------------------+---------------------------------------+
| Configuration file | /etc/groonga/httpd/groonga-httpd.conf |
+--------------------+---------------------------------------+
Start HTTP server
^^^^^^^^^^^^^^^^^
Starting groonga HTTP server(Debian/Ubuntu/AlmaLinux)::
  % sudo service groonga-httpd start
Starting groonga HTTP server(Fedora)::
  % sudo systemctl start groonga-httpd
Stop HTTP server
^^^^^^^^^^^^^^^^
Stopping groonga HTTP server(Debian/Ubuntu/AlmaLinux)::
  % sudo service groonga-httpd stop
Starting groonga HTTP server(Fedora)::
  % sudo systemctl stop groonga-httpd
Restart HTTP server
^^^^^^^^^^^^^^^^^^^
Restarting groonga HTTP server(Debian/Ubuntu/AlmaLinux)::
  % sudo service groonga-httpd restart
Restarting groonga HTTP server(Fedora)::
  % sudo systemctl restart groonga-httpd
groonga-server-gqtp
-------------------
``groonga-server-gqtp`` is a :doc:`/spec/gqtp` based server package.
+--------------------+---------------------------------------+
| Item               | Default value                         |
+====================+=======================================+
| Port number        | 10043                                 |
+--------------------+---------------------------------------+
| :ref:`process-log` | /var/log/groonga/groonga-gqtp.log     |
+--------------------+---------------------------------------+
| :ref:`query-log`   | /var/log/groonga/gqtp-query.log       |
+--------------------+---------------------------------------+
| Database           | /var/lib/groonga/db/*                 |
+--------------------+---------------------------------------+
Configuration file for server setting (Debian/Ubuntu)::
  /etc/default/groonga/groonga-server-gqtp
Configuration file for server setting (AlmaLinux)::
  /etc/sysconfig/groonga-server-gqtp
Start GQTP server
^^^^^^^^^^^^^^^^^
Starting groonga GQTP server(Debian/Ubuntu/AlmaLinux)::
  % sudo service groonga-server-gqtp start
Starting groonga GQTP server(Fedora)::
  % sudo systemctl start groonga-server-gqtp
Stop GQTP server
^^^^^^^^^^^^^^^^
Stopping groonga GQTP server(Debian/Ubuntu/AlmaLinux)::
  % sudo service groonga-server-http stop
Stopping groonga GQTP server(Fedora)::
  % sudo systemctl stop groonga-server-gqtp
Restart GQTP server
^^^^^^^^^^^^^^^^^^^
Restarting groonga HTTP server(Debian/Ubuntu/AlmaLinux)::
  % sudo service groonga-server-gqtp restart
Restarting groonga HTTP server(Fedora)::
  % sudo systemctl restart groonga-server-gqtp
groonga-server-http
-------------------
``groonga-server-http`` is a simple HTTP based server package.
Preconfigured setting:
+--------------------+---------------------------------------+
| Item               | Default value                         |
+====================+=======================================+
| Port number        | 10041                                 |
+--------------------+---------------------------------------+
| :ref:`process-log` | /var/log/groonga/groonga-http.log     |
+--------------------+---------------------------------------+
| :ref:`query-log`   | /var/log/groonga/http-query.log       |
+--------------------+---------------------------------------+
| Database           | /var/lib/groonga/db/*                 |
+--------------------+---------------------------------------+
Configuration file for server setting (Debian/Ubuntu)::
  /etc/default/groonga/groonga-server-http
Configuration file for server setting (AlmaLinux)::
  /etc/sysconfig/groonga-server-http
Start HTTP server
^^^^^^^^^^^^^^^^^
Starting groonga HTTP server(Debian/Ubuntu/AlmaLinux)::
  % sudo service groonga-server-http start
Starting groonga HTTP server(Fedora)::
  % sudo systemctl start groonga-server-http
Stop HTTP server
^^^^^^^^^^^^^^^^
Stopping groonga HTTP server(Debian/Ubuntu/AlmaLinux)::
  % sudo service groonga-server-http stop
Stopping groonga HTTP server(Fedora)::
  % sudo systemctl stop groonga-server-http
Restart HTTP server
^^^^^^^^^^^^^^^^^^^
Restarting groonga HTTP server(Debian/Ubuntu/AlmaLinux)::
  % sudo service groonga-server-http restart
Restarting groonga HTTP server(Fedora)::
  % sudo systemctl restart groonga-server-http
 |