Documentation Index
Fetch the complete documentation index at: https://www.meilisearch.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Supported operating systems
Meilisearch officially supports the following operating systems. Binaries might work on other environments without official support.
| OS | Requirements |
|---|
| Linux | amd64/x86_64 or aarch64/arm64 with glibc 2.35+. Check with ldd --version. |
| macOS | macOS 14 Sonoma or later, amd64 or arm64. |
| Windows | Windows Server 2022 or later. Windows OS 10+ may work but is not officially supported. |
Use Meilisearch Cloud to integrate Meilisearch with applications hosted in unsupported operating systems. Meilisearch Cloud
Meilisearch Cloud simplifies installing, maintaining, and updating Meilisearch. Get started with a 14-day free trial.
Take a look at the Meilisearch Cloud tutorial for more information on setting up and using Meilisearch’s cloud service.
Local installation
cURL
Homebrew
Docker
APT
Source
Windows
Direct download
Download the latest stable release of Meilisearch with cURL.Launch Meilisearch to start the server.# Install Meilisearch
curl -L https://install.meilisearch.com | sh
# Launch Meilisearch
./meilisearch
Download the latest stable release of Meilisearch with Homebrew, a package manager for MacOS.
Launch Meilisearch to start the server.# Update brew and install Meilisearch
brew update && brew install meilisearch
# Launch Meilisearch
meilisearch
When using Docker, you can run any tag available in our official Docker image.
These commands launch the latest stable release of Meilisearch.# Fetch the latest version of Meilisearch image from DockerHub
docker pull getmeili/meilisearch:v1.37
# Launch Meilisearch in development mode with a master key
docker run -it --rm \
-p 7700:7700 \
-e MEILI_ENV='development' \
-v $(pwd)/meili_data:/meili_data \
getmeili/meilisearch:v1.37
# Use ${pwd} instead of $(pwd) in PowerShell
Download the latest stable release of Meilisearch with APT.
Launch Meilisearch to start the server.# Add Meilisearch package
echo "deb [trusted=yes] https://apt.fury.io/meilisearch/ /" | sudo tee /etc/apt/sources.list.d/fury.list
# Update APT and install Meilisearch
sudo apt update && sudo apt install meilisearch
# Launch Meilisearch
meilisearch
Meilisearch is written in Rust. To compile it, install the Rust toolchain.
Once the Rust toolchain is installed, clone the repository on your local system and change it to your working directory.git clone https://github.com/meilisearch/meilisearch
cd meilisearch
In the cloned repository, run the following command to access the most recent version of Meilisearch:Finally, update the Rust toolchain, compile the project, and execute the binary.# Update the Rust toolchain to the latest version
rustup update
# Compile the project
cargo build --release
# Execute the binary
./target/release/meilisearch
To install Meilisearch on Windows, you can:
- Use Docker (see “Docker” tab above)
- Download the latest binary (see “Direct download” tab above)
- Use the installation script (see “cURL” tab above) if you have installed Cygwin, WSL, or equivalent
- Compile from source (see “Source” tab above)
To learn more about the Windows command prompt, follow this introductory guide. If none of the other installation options work for you, you can always download the Meilisearch binary directly on GitHub.
Go to the latest Meilisearch release, scroll down to “Assets”, and select the binary corresponding to your operating system.# Rename binary to meilisearch. Replace {meilisearch_os} with the name of the downloaded binary
mv {meilisearch_os} meilisearch
# Give the binary execute permission
chmod +x meilisearch
# Launch Meilisearch
./meilisearch
Installing older versions of Meilisearch
We discourage the use of older Meilisearch versions. Before installing an older version, please contact support to check if the latest version might work as well.
cURL
Docker
Source
Direct download
Download the binary of a specific version under “Assets” on our GitHub changelog.# Replace {meilisearch_version} and {meilisearch_os} with the specific version and OS you want to download
# For example, if you want to download v1.0 on macOS,
# replace {meilisearch_version} and {meilisearch_os} with v1.0 and meilisearch-macos-amd64 respectively
curl -OL https://github.com/meilisearch/meilisearch/releases/download/{meilisearch_version}/{meilisearch_os}
# Rename binary to meilisearch. Replace {meilisearch_os} with the name of the downloaded binary
mv {meilisearch_os} meilisearch
# Give the binary execute permission
chmod +x meilisearch
# Launch Meilisearch
./meilisearch
When using Docker, you can run any tag available in our official Docker image.
# Fetch specific version of Meilisearch image from DockerHub. Replace vX.Y.Z with the version you want to use
docker pull getmeili/meilisearch:vX.Y.Z
# Launch Meilisearch in development mode with a master key
docker run -it --rm \
-p 7700:7700 \
-e MEILI_ENV='development' \
-v $(pwd)/meili_data:/meili_data \
getmeili/meilisearch:vX.Y.Z
# Use ${pwd} instead of $(pwd) in PowerShell
Meilisearch is written in Rust. To compile it, install the Rust toolchain.
Once the Rust toolchain is installed, clone the repository on your local system and change it to your working directory.git clone https://github.com/meilisearch/meilisearch
cd meilisearch
In the cloned repository, run the following command to access a specific version of Meilisearch:# Replace vX.Y.Z with the specific version you want to use
git checkout vX.Y.Z
# Update the Rust toolchain to the latest version
rustup update
# Compile the project
cargo build --release
# Execute the binary
./target/release/meilisearch
Download the binary of a specific version under “Assets” on our GitHub changelog.# Rename binary to meilisearch. Replace {meilisearch_os} with the name of the downloaded binary
mv {meilisearch_os} meilisearch
# Give the binary execute permission
chmod +x meilisearch
# Launch Meilisearch
./meilisearch
Troubleshooting
If the provided binaries do not work on your operating system, try building Meilisearch from source. If compilation fails, Meilisearch is not compatible with your machine.
