.. -*- rst -*-

.. highlightlang:: none

Install
=======

This section describes how to install groonga on each environment.

We distribute both 32-bit and 64-bit packages but we strongly recommend a 64-bit package for server. You should use a 32-bit package just only for tests or development. You will encounter an out of memory error with a 32-bit package even if you just process medium size data.


Debian GNU/Linux squeeze
------------------------

/etc/apt/sources.list.d/groonga.list::

  deb http://packages.groonga.org/debian/ squeeze main
  deb-src http://packages.groonga.org/debian/ squeeze main

Install::

  % sudo aptitude update
  % sudo aptitude -V -D -y --allow-untrusted install groonga-keyring
  % sudo aptitude -V -D -y install groonga

If you want to use `MeCab <http://mecab.sourceforge.net/>`_ as a tokenizer. please install groonga-tokenizer-mecab package.

Install groonga-tokenizer-mecab package::

  % sudo aptitude -V -D -y install groonga-tokenizer-mecab

There is a package that provides `Munin <http://munin-monitoring.org/>`_ plugins. If you want to monitor groonga status by Munin, please install groonga-munin-plugins package.

Install groonga-munin-plugins package::

  % sudo aptitude -V -D -y install groonga-munin-plugins

Debian GNU/Linux wheezy
-----------------------

/etc/apt/sources.list.d/groonga.list::

  deb http://packages.groonga.org/debian/ wheezy main
  deb-src http://packages.groonga.org/debian/ wheezy main

Install::

  % sudo aptitude update
  % sudo aptitude -V -D -y --allow-untrusted install groonga-keyring
  % sudo aptitude -V -D -y install groonga

If you want to use `MeCab <http://mecab.sourceforge.net/>`_ as a tokenizer. please install groonga-tokenizer-mecab package.

Install groonga-tokenizer-mecab package::

  % sudo aptitude -V -D -y install groonga-tokenizer-mecab

There is a package that provides `Munin <http://munin-monitoring.org/>`_ plugins. If you want to monitor groonga status by Munin, please install groonga-munin-plugins package.

Install groonga-munin-plugins package::

  % sudo aptitude -V -D -y install groonga-munin-plugins

Debian GNU/Linux sid
--------------------

/etc/apt/sources.list.d/groonga.list::

  deb http://packages.groonga.org/debian/ unstable main
  deb-src http://packages.groonga.org/debian/ unstable main

Install::

  % sudo aptitude update
  % sudo aptitude -V -D -y --allow-untrusted install groonga-keyring
  % sudo aptitude -V -D -y install groonga

If you want to use `MeCab <http://mecab.sourceforge.net/>`_ as a tokenizer. please install groonga-tokenizer-mecab package.

Install groonga-tokenizer-mecab package::

  % sudo aptitude -V -D -y install groonga-tokenizer-mecab

There is a package that provides `Munin <http://munin-monitoring.org/>`_ plugins. If you want to monitor groonga status by Munin, please install groonga-munin-plugins package.

Install groonga-munin-plugins package::

  % sudo aptitude -V -D -y install groonga-munin-plugins

Ubuntu 10.04 LTS Lucid Lynx
---------------------------

.. note::

   You'll need to enable the universe repository of Ubuntu to install groonga.
   The following describes how to do it.

/etc/apt/sources.list.d/groonga.list::

  deb http://packages.groonga.org/ubuntu/ lucid universe
  deb-src http://packages.groonga.org/ubuntu/ lucid universe

Install::

  % sudo apt-get update
  % sudo apt-get -y --allow-unauthenticated install groonga-keyring
  % sudo apt-get -y install groonga

If you want to use `MeCab <http://mecab.sourceforge.net/>`_ as a tokenizer. please install groonga-tokenizer-mecab package.

Install groonga-tokenizer-mecab package::

  % sudo apt-get -y install groonga-tokenizer-mecab

There is a package that provides `Munin <http://munin-monitoring.org/>`_ plugins. If you want to monitor groonga status by Munin, please install groonga-munin-plugins package.

Install groonga-munin-plugins package::

  % sudo apt-get -y install groonga-munin-plugins

Ubuntu 11.04 Natty Narwhal
--------------------------

.. note::

   You'll need to enable the universe repository of Ubuntu to install groonga.
   The following describes how to do it.

/etc/apt/sources.list.d/groonga.list::

  deb http://packages.groonga.org/ubuntu/ natty universe
  deb-src http://packages.groonga.org/ubuntu/ natty universe

Install::

  % sudo apt-get update
  % sudo apt-get -y --allow-unauthenticated install groonga-keyring
  % sudo apt-get -y install groonga

If you want to use `MeCab <http://mecab.sourceforge.net/>`_ as a tokenizer. please install groonga-tokenizer-mecab package.

Install groonga-tokenizer-mecab package::

  % sudo apt-get -y install groonga-tokenizer-mecab

There is a package that provides `Munin <http://munin-monitoring.org/>`_ plugins. If you want to monitor groonga status by Munin, please install groonga-munin-plugins package.

Install groonga-munin-plugins package::

  % sudo apt-get -y install groonga-munin-plugins

Ubuntu 11.10 Oneiric Ocelot
---------------------------

.. note::

   You'll need to enable the universe repository of Ubuntu to install groonga.
   The following describes how to do it.

/etc/apt/sources.list.d/groonga.list::

  deb http://packages.groonga.org/ubuntu/ oneiric universe
  deb-src http://packages.groonga.org/ubuntu/ oneiric universe

Install::

  % sudo apt-get update
  % sudo apt-get -y --allow-unauthenticated install groonga-keyring
  % sudo apt-get -y install groonga

If you want to use `MeCab <http://mecab.sourceforge.net/>`_ as a tokenizer. please install groonga-tokenizer-mecab package.

Install groonga-tokenizer-mecab package::

  % sudo apt-get -y install groonga-tokenizer-mecab

There is a package that provides `Munin <http://munin-monitoring.org/>`_ plugins. If you want to monitor groonga status by Munin, please install groonga-munin-plugins package.

Install groonga-munin-plugins package::

  % sudo apt-get -y install groonga-munin-plugins

Ubuntu 12.04 Precise Pangolin
-----------------------------

.. note::

   You'll need to enable the universe repository of Ubuntu to install groonga.
   The following describes how to do it.

/etc/apt/sources.list.d/groonga.list::

  deb http://packages.groonga.org/ubuntu/ precise universe
  deb-src http://packages.groonga.org/ubuntu/ precise universe

Install::

  % sudo apt-get update
  % sudo apt-get -y --allow-unauthenticated install groonga-keyring
  % sudo apt-get -y install groonga

If you want to use `MeCab <http://mecab.sourceforge.net/>`_ as a tokenizer. please install groonga-tokenizer-mecab package.

Install groonga-tokenizer-mecab package::

  % sudo apt-get -y install groonga-tokenizer-mecab

There is a package that provides `Munin <http://munin-monitoring.org/>`_ plugins. If you want to monitor groonga status by Munin, please install groonga-munin-plugins package.

Install groonga-munin-plugins package::

  % sudo apt-get -y install groonga-munin-plugins

CentOS 5
--------

Install::

  % sudo rpm -ivh http://packages.groonga.org/centos/groonga-repository-1.0.1-0.noarch.rpm
  % sudo yum update
  % sudo yum install -y groonga

If you want to use `MeCab <http://mecab.sourceforge.net/>`_ as a tokenizer. please install groonga-tokenizer-mecab package.

Install groonga-tokenizer-mecab package::

  % sudo yum install -y groonga-tokenizer-mecab

There is a package that provides `Munin <http://munin-monitoring.org/>`_ plugins. If you want to monitor groonga status by Munin, please install groonga-munin-plugins package.

.. note::

   Groonga-munin-plugins package requires munin-node package that isn't included in the official CentOS repository. You need to enable `Repoforge (RPMforge) <http://repoforge.org/>`_ repository or `EPEL <http://fedoraproject.org/wiki/EPEL>`_ repository to install it by yum.

   Enable Repoforge (RPMforge) repository on i386 environment::

     % sudo rpm -ivh http://pkgs.repoforge.org/rpmforge-release/rpmforge-release-0.5.2-2.el5.rf.i386.rpm

   Enable Repoforge (RPMforge) repository on x86_64 environment::

     % sudo rpm -ivh http://pkgs.repoforge.org/rpmforge-release/rpmforge-release-0.5.2-2.el5.rf.x86_64.rpm

   Enable EPEL repository on any environment::

     % sudo rpm -ivh http://download.fedoraproject.org/pub/epel/5/i386/epel-release-5-4.noarch.rpm

Install groonga-munin-plugins package::

  % sudo yum update
  % sudo yum install -y groonga-munin-plugins

CentOS 6
--------

Install::

  % sudo rpm -ivh http://packages.groonga.org/centos/groonga-repository-1.0.1-0.noarch.rpm
  % sudo yum update
  % sudo yum install -y groonga

If you want to use `MeCab <http://mecab.sourceforge.net/>`_ as a tokenizer. please install groonga-tokenizer-mecab package.

Install groonga-tokenizer-mecab package::

  % sudo yum install -y groonga-tokenizer-mecab

There is a package that provides `Munin <http://munin-monitoring.org/>`_ plugins. If you want to monitor groonga status by Munin, please install groonga-munin-plugins package.

.. note::

   Groonga-munin-plugins package requires munin-node package that isn't included in the official CentOS repository. You need to enable `Repoforge (RPMforge) <http://repoforge.org/>`_ repository or `EPEL <http://fedoraproject.org/wiki/EPEL>`_ repository to install it by yum.

   Enable Repoforge (RPMforge) repository on i686 environment::

     % sudo rpm -ivh http://pkgs.repoforge.org/rpmforge-release/rpmforge-release-0.5.2-2.el6.rf.i686.rpm

   Enable Repoforge (RPMforge) repository on x86_64 environment::

     % sudo rpm -ivh http://pkgs.repoforge.org/rpmforge-release/rpmforge-release-0.5.2-2.el6.rf.x86_64.rpm

   Enable EPEL repository on any environment::

     % sudo rpm -ivh http://download.fedoraproject.org/pub/epel/6/i386/epel-release-6-5.noarch.rpm

Install groonga-munin-plugins package::

  % sudo yum update
  % sudo yum install -y groonga-munin-plugins

Fedora 16
---------

Install::

  % sudo rpm -ivh http://packages.groonga.org/fedora/groonga-repository-1.0.1-0.noarch.rpm
  % sudo yum update
  % sudo yum install -y groonga

If you want to use `MeCab <http://mecab.sourceforge.net/>`_ as a tokenizer. please install groonga-tokenizer-mecab package.

Install groonga-tokenizer-mecab package::

  % sudo yum install -y groonga-tokenizer-mecab

There is a package that provides `Munin <http://munin-monitoring.org/>`_ plugins. If you want to monitor groonga status by Munin, please install groonga-munin-plugins package.

Install groonga-munin-plugins package::

  % sudo yum install -y groonga-munin-plugins

Mac OS X (MacPorts)
-------------------

Install::

  % sudo port install groonga

Mac OS X (Homebrew)
-------------------

Install::

  % brew install groonga

Windows (Installer)
-------------------

You just download an installer (.exe file) from
`packages.groonga.org/windows/ <http://packages.groonga.org/windows/groonga/>`_
and execute it.

Windows (zip)
-------------

You just download a zip file from
`packages.groonga.org/windows/ <http://packages.groonga.org/windows/groonga/>`_
and extract it.

Others
------

If you want to use a morphological analyzer for tokenization in full-text indexing, please install `MeCab <http://mecab.sourceforge.net/>`_ before installing groonga.

Then, download a tar.gz file from `packages.groonga.org/source/ <http://packages.groonga.org/source/groonga/>`_ and extract it. After that, please run the following command to install groonga.

Install::

 ./configure --prefix=/usr --localstatedir=/var && make && sudo make install

The ``--prefix`` option specifies the path to install groonga. If you don't specify the install path, "/usr/local" is used. Please specify "/usr" if you are not familiar with environment variables such as LD_LIBRARY_PATH.

There are some `Munin <http://munin-monitoring.org/>`_ plugins in groonga package. You need to specify `--with-munin-plugins` option if you want to install them.
