2. Install — Groonga v16.0.4 documentation

Skip to main content
`Ctrl`+`K`

# 2. Install

This section describes how to install Groonga on each environment. There are packages for major platforms. It’s recommended that you use package instead of building Groonga by yourself. But don’t warry. There is a document about building Groonga from source.

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.

- 2.1. Windows
  - 2.1.1. zip
  - 2.1.2. Build from source
- 2.2. macOS
  - 2.2.1. MacPorts
  - 2.2.2. Homebrew
  - 2.2.3. Build from source
- 2.3. Debian GNU/Linux
  - 2.3.1. trixie
  - 2.3.2. bookworm
  - 2.3.3. Build from source
- 2.4. Ubuntu
  - 2.4.1. Register Groonga APT repository
    - 2.4.1.1. Groonga APT Repository (packages.groonga.org)
    - 2.4.1.2. Deprecated Groonga PPA (Personal Package Archive)
  - 2.4.2. `groonga` package
  - 2.4.3. `groonga-tokenizer-mecab` package
  - 2.4.4. `groonga-token-filter-stem` package
  - 2.4.5. `groonga-munin-plugins` package
  - 2.4.6. `groonga-normalizer-mysql` package
  - 2.4.7. Build from source
  - 2.4.8. Migration from Groonga PPA (ppa:groonga/ppa) to Groonga APT Repository (packages.groonga.org)
    - 2.4.8.1. Configure the Groonga APT Repository
      - 2.4.8.1.1. Register Groonga APT Repository
      - 2.4.8.1.2. Remove the Existing Package Source
    - 2.4.8.2. Upgrade Package
      - 2.4.8.2.1. Option 1: Use Groonga APT Repository from the Next Release (Recommended)
      - 2.4.8.2.2. Option 2: Use Groonga APT Repository Immediately Without Waiting for Next Release
- 2.5. AlmaLinux
  - 2.5.1. AlmaLinux 10
  - 2.5.2. AlmaLinux 9
  - 2.5.3. AlmaLinux 8
  - 2.5.4. Build from source
- 2.6. Amazon Linux
  - 2.6.1. Amazon Linux 2023
  - 2.6.2. Build from source
- 2.7. Docker
  - 2.7.1. Pulling image
  - 2.7.2. With docker-compose
- 2.8. Others: Build with CMake
  - 2.8.1. Install depended software
    - 2.8.1.1. GNU/Linux or UNIX
      - 2.8.1.1.1. macOS
    - 2.8.1.2. Windows
  - 2.8.2. Download source
    - 2.8.2.1. GNU/Linux or UNIX
    - 2.8.2.2. Windows
  - 2.8.3. Run `cmake`
    - 2.8.3.1. CMake presets
    - 2.8.3.2. CMake options
      - 2.8.3.2.1. `-G GENERATOR`
      - 2.8.3.2.2. `-DCMAKE_INSTALL_PREFIX`
      - 2.8.3.2.3. `-DGRN_WITH_MRUBY`
      - 2.8.3.2.4. `-DGRN_WITH_APACHE_ARROW`
      - 2.8.3.2.5. `-DCMAKE_PREFIX_PATH=PATHS`
  - 2.8.4. Build and install Groonga
    - 2.8.4.1. GNU/Linux or UNIX
    - 2.8.4.2. Windows