Installation

Download and launch

<>

cURL

Homebrew

Docker

APT

Source

Windows

Download the latest stable release of MeiliSearch with cURL.

Launch MeiliSearch to start the server.

  1. # Install MeiliSearch
  2. curl -L https://install.meilisearch.com | sh
  4. # Launch MeiliSearch
  5. ./meilisearch

Download the latest stable release of MeiliSearch with Homebrew.

Launch MeiliSearch to start the server.

  1. # Update brew and install MeiliSearch
  2. brew update && brew install meilisearch
  4. # Launch MeiliSearch
  5. meilisearch

Using Docker you can choose to run any available tagInstallation - 图1 (opens new window).

This command starts the latest stable release of MeiliSearch.

  1. # Fetch the latest version of MeiliSearch image from DockerHub
  2. docker pull getmeili/meilisearch:latest
  4. # Launch MeiliSearch
  5. docker run -it --rm \
  6.     -p 7700:7700 \
  7.     -v $(pwd)/data.ms:/data.ms \
  8.     getmeili/meilisearch:latest

Data written to a Docker container is not persistent and is deleted along with the container when the latter is stopped. Docker volumes are not deleted when containers are removed. It is then recommended to share volumes between your containers and your host machine to provide persistent storage. MeiliSearch writes data to /data.ms

You can learn more about Docker on the official documentationInstallation - 图2 (opens new window).

Download the latest stable release of MeiliSearch with APT.

Launch MeiliSearch to start the server.

  1. # Add MeiliSearch package
  2. echo "deb [trusted=yes] https://apt.fury.io/meilisearch/ /" > /etc/apt/sources.list.d/fury.list
  4. # Update APT and install MeiliSearch
  5. apt update && apt install meilisearch-http
  7. # Launch MeiliSearch
  8. meilisearch

MeiliSearch is written in Rust. To compile it, installing the Rust toolchainInstallation - 图3 (opens new window) is required.

If the Rust toolchain is already installed, clone the repository on your local system and change it to your working directory.

  1. git clone https://github.com/meilisearch/MeiliSearch
  2. cd MeiliSearch

In the cloned repository, compile MeiliSearch.

  1. # Update the rust toolchain to the latest version
  2. rustup update
  4. # Compile the project
  5. cargo build --release
  7. # Execute the server binary
  8. ./target/release/meilisearch

To install MeiliSearch on Windows, you can:

To learn more about the Windows command prompt, follow this introductory guideInstallation - 图6 (opens new window).

Compile for Best Performance

For best performance, compile MeiliSearch on the machine you intend to run it on. This way, the binary is optimized for your specific architecture.

Cloud deploy

To deploy MeiliSearch on a cloud service, follow one of our dedicated guides:

Configuration options

Configuration options are added at launch, either through command line options or through environment variables.

This is an example using the command line options.

  1. ./meilisearch --db-path ./meilifiles --http-addr '127.0.0.1:7700'

Here is a list of all the options and how to use them.

Updating MeiliSearch

Getting the latest version of MeiliSearch is a straightforward process: simply fetch and install the latest binary with your preferred method (see Installation above).

However, please note that prior to our official release (v1.0), databases are not compatible across versions. Any database created by MeiliSearch v0.X can only be read by that version.

Migrating your database to a later version

If you get the error Cannot open database, expected MeiliSearch engine version: X.X.X, current engine version Y.Y.Y, your database is not compatible with the version you’re using. To migrate your database to the most recent version of MeiliSearch, follow our dedicated guide.