2020-03-26 19:24:02 +08:00
< p align = "center" >
2020-04-05 17:02:42 +08:00
< img src = "assets/logo.svg" alt = "MeiliSearch" width = "200" height = "200" / >
2020-03-26 19:24:02 +08:00
< / p >
2020-03-26 19:23:09 +08:00
< h1 align = "center" > MeiliSearch< / h1 >
2019-10-09 22:39:09 +08:00
2020-03-26 19:42:41 +08:00
< h4 align = "center" >
2020-05-27 18:03:23 +08:00
< a href = "https://www.meilisearch.com" > Website< / a > |
2020-12-14 22:38:47 +08:00
< a href = "https://roadmap.meilisearch.com/tabs/1-under-consideration" > Roadmap< / a > |
2020-05-27 18:03:23 +08:00
< a href = "https://blog.meilisearch.com" > Blog< / a > |
< a href = "https://fr.linkedin.com/company/meilisearch" > LinkedIn< / a > |
< a href = "https://twitter.com/meilisearch" > Twitter< / a > |
< a href = "https://docs.meilisearch.com" > Documentation< / a > |
2021-02-03 06:24:56 +08:00
< a href = "https://docs.meilisearch.com/faq/" > FAQ< / a >
2020-03-26 19:42:41 +08:00
< / h4 >
2020-03-26 19:31:58 +08:00
2020-03-26 23:24:03 +08:00
< p align = "center" >
< a href = "https://github.com/meilisearch/MeiliSearch/actions" > < img src = "https://github.com/meilisearch/MeiliSearch/workflows/Cargo%20test/badge.svg" alt = "Build Status" > < / a >
< a href = "https://deps.rs/repo/github/meilisearch/MeiliSearch" > < img src = "https://deps.rs/repo/github/meilisearch/MeiliSearch/status.svg" alt = "Dependency status" > < / a >
< a href = "https://github.com/meilisearch/MeiliSearch/blob/master/LICENSE" > < img src = "https://img.shields.io/badge/license-MIT-informational" alt = "License" > < / a >
< a href = "https://slack.meilisearch.com" > < img src = "https://img.shields.io/badge/slack-MeiliSearch-blue.svg?logo=slack" alt = "Slack" > < / a >
2020-04-20 16:54:08 +08:00
< a href = "https://github.com/meilisearch/MeiliSearch/discussions" alt = "Discussions" > < img src = "https://img.shields.io/badge/github-discussions-red" / > < / a >
2020-07-08 20:33:15 +08:00
< a href = "https://app.bors.tech/repositories/26457" > < img src = "https://bors.tech/images/badge_small.svg" alt = "Bors enabled" > < / a >
2020-03-26 23:24:03 +08:00
< / p >
2019-10-09 22:39:09 +08:00
2020-04-01 22:34:24 +08:00
< p align = "center" > ⚡ Lightning Fast, Ultra Relevant, and Typo-Tolerant Search Engine 🔍< / p >
2019-11-12 23:51:08 +08:00
2020-03-26 19:23:09 +08:00
**MeiliSearch** is a powerful, fast, open-source, easy to use and deploy search engine. Both searching and indexing are highly customizable. Features such as typo-tolerance, filters, and synonyms are provided out-of-the-box.
2020-03-26 18:59:40 +08:00
For more information about features go to [our documentation ](https://docs.meilisearch.com/ ).
2019-10-09 22:39:09 +08:00
2020-03-27 18:28:57 +08:00
< p align = "center" >
2020-11-12 17:05:39 +08:00
< img src = "assets/trumen_quick_loop.gif" alt = "Web interface gif" / >
2020-03-27 18:28:57 +08:00
< / p >
2020-07-02 22:16:53 +08:00
## ✨ Features
2020-03-26 19:23:09 +08:00
* Search as-you-type experience (answers < 50 milliseconds )
2019-11-26 21:23:56 +08:00
* Full-text search
2020-03-26 19:23:09 +08:00
* Typo tolerant (understands typos and miss-spelling)
2020-07-02 22:16:53 +08:00
* Faceted search and filters
2020-04-15 22:04:50 +08:00
* Supports Kanji characters
2019-11-26 21:23:56 +08:00
* Supports Synonym
* Easy to install, deploy, and maintain
2020-03-26 18:59:40 +08:00
* Whole documents are returned
2019-11-26 21:23:56 +08:00
* Highly customizable
2020-03-26 18:59:40 +08:00
* RESTful API
2019-10-09 22:39:09 +08:00
2020-07-02 22:16:53 +08:00
## Getting started
2019-11-09 19:59:21 +08:00
### Deploy the Server
2021-01-27 04:14:53 +08:00
#### Homebrew (Mac OS)
2020-05-13 21:41:31 +08:00
2019-12-04 22:36:15 +08:00
```bash
2020-07-02 22:16:53 +08:00
brew update & & brew install meilisearch
meilisearch
2019-12-04 22:36:15 +08:00
```
2020-05-13 21:41:31 +08:00
2020-07-02 22:16:53 +08:00
#### Docker
2019-11-09 19:59:21 +08:00
2019-12-04 22:36:15 +08:00
```bash
2020-03-31 18:16:46 +08:00
docker run -p 7700:7700 -v $(pwd)/data.ms:/data.ms getmeili/meilisearch
2019-12-04 22:36:15 +08:00
```
2019-12-03 00:17:16 +08:00
2020-10-22 23:02:58 +08:00
#### Try MeiliSearch in our Sandbox
Create a MeiliSearch instance in [MeiliSearch Sandbox ](https://sandbox.meilisearch.com/ ). This instance is free, and will be active for 72 hours.
2020-07-02 22:16:53 +08:00
#### Run on Digital Ocean
2020-01-08 18:30:33 +08:00
2020-07-02 22:16:53 +08:00
[](https://marketplace.digitalocean.com/apps/meilisearch?action=deploy& refcode=7c67bd97e101)
2020-01-08 18:30:33 +08:00
2020-11-18 04:05:17 +08:00
#### Deploy on Platform.sh
< a href = "https://console.platform.sh/projects/create-project?template=https://raw.githubusercontent.com/platformsh/template-builder/master/templates/meilisearch/.platform.template.yaml&utm_content=meilisearch&utm_source=github&utm_medium=button&utm_campaign=deploy_on_platform" >
< img src = "https://platform.sh/images/deploy/lg-blue.svg" alt = "Deploy on Platform.sh" width = "180px" / >
< / a >
2020-07-02 22:16:53 +08:00
#### APT (Debian & Ubuntu)
2019-12-05 21:02:36 +08:00
```bash
echo "deb [trusted=yes] https://apt.fury.io/meilisearch/ /" > /etc/apt/sources.list.d/fury.list
apt update & & apt install meilisearch-http
meilisearch
```
2020-07-02 22:16:53 +08:00
#### Download the binary (Linux & Mac OS)
2019-12-04 22:36:15 +08:00
```bash
2019-12-03 00:17:16 +08:00
curl -L https://install.meilisearch.com | sh
./meilisearch
2019-11-13 22:37:21 +08:00
```
2019-12-04 22:36:15 +08:00
#### Compile and run it from sources
2020-04-26 20:18:20 +08:00
If you have the latest stable Rust toolchain installed on your local system, clone the repository and change it to your working directory.
2019-12-04 22:36:15 +08:00
```bash
git clone https://github.com/meilisearch/MeiliSearch.git
cd MeiliSearch
2020-03-26 20:13:02 +08:00
```
In the cloned repository, compile MeiliSearch.
```bash
2020-07-01 19:35:37 +08:00
rustup override set stable
rustup update stable
2019-12-04 22:36:15 +08:00
cargo run --release
```
2019-11-09 19:59:21 +08:00
### Create an Index and Upload Some Documents
2020-03-26 18:59:40 +08:00
Let's create an index! If you need a sample dataset, use [this movie database ](https://www.notion.so/meilisearch/A-movies-dataset-to-test-Meili-1cbf7c9cfa4247249c40edfa22d7ca87#b5ae399b81834705ba5420ac70358a65 ). You can also find it in the `datasets/` directory.
2019-12-03 00:17:16 +08:00
```bash
2019-12-10 23:49:22 +08:00
curl -L 'https://bit.ly/2PAcw9l' -o movies.json
2019-12-03 00:17:16 +08:00
```
2020-03-26 18:59:40 +08:00
MeiliSearch can serve multiple indexes, with different kinds of documents.
It is required to create an index before sending documents to it.
2019-11-09 19:59:21 +08:00
```bash
2019-11-30 01:02:32 +08:00
curl -i -X POST 'http://127.0.0.1:7700/indexes' --data '{ "name": "Movies", "uid": "movies" }'
2019-11-09 19:59:21 +08:00
```
2020-03-26 18:59:40 +08:00
Now that the server knows about your brand new index, you're ready to send it some data.
2019-11-09 19:59:21 +08:00
```bash
2019-11-30 01:02:32 +08:00
curl -i -X POST 'http://127.0.0.1:7700/indexes/movies/documents' \
2019-11-09 19:59:21 +08:00
--header 'content-type: application/json' \
2019-12-03 00:17:16 +08:00
--data-binary @movies .json
2019-11-09 19:59:21 +08:00
```
### Search for Documents
2019-12-18 17:09:03 +08:00
#### In command line
2020-05-27 18:03:23 +08:00
The search engine is now aware of your documents and can serve those via an HTTP server.
2020-03-26 20:18:11 +08:00
2020-03-26 18:59:40 +08:00
The [`jq` command-line tool ](https://stedolan.github.io/jq/ ) can greatly help you read the server responses.
2019-11-09 19:59:21 +08:00
```bash
2019-12-03 00:17:16 +08:00
curl 'http://127.0.0.1:7700/indexes/movies/search?q=botman+robin& limit=2' | jq
2019-11-09 19:59:21 +08:00
```
```json
{
"hits": [
{
2019-12-03 00:17:16 +08:00
"id": "415",
"title": "Batman & Robin",
"poster": "https://image.tmdb.org/t/p/w1280/79AYCcxw3kSKbhGpx1LiqaCAbwo.jpg",
"overview": "Along with crime-fighting partner Robin and new recruit Batgirl...",
"release_date": "1997-06-20",
2019-11-09 19:59:21 +08:00
},
{
2019-12-03 00:17:16 +08:00
"id": "411736",
"title": "Batman: Return of the Caped Crusaders",
"poster": "https://image.tmdb.org/t/p/w1280/GW3IyMW5Xgl0cgCN8wu96IlNpD.jpg",
"overview": "Adam West and Burt Ward returns to their iconic roles of Batman and Robin...",
"release_date": "2016-10-08",
2019-11-09 19:59:21 +08:00
}
],
"offset": 0,
"limit": 2,
"processingTimeMs": 1,
2019-12-03 00:17:16 +08:00
"query": "botman robin"
2019-11-09 19:59:21 +08:00
}
```
2020-03-26 18:59:40 +08:00
#### Use the Web Interface
2019-12-18 17:09:03 +08:00
2020-03-26 19:23:09 +08:00
We also deliver an **out-of-the-box web interface** in which you can test MeiliSearch interactively.
2019-12-18 17:09:03 +08:00
2020-03-26 20:18:11 +08:00
You can access the web interface in your web browser at the root of the server. The default URL is [http://127.0.0.1:7700 ](http://127.0.0.1:7700 ). All you need to do is open your web browser and enter MeiliSearch’
2019-12-18 17:09:03 +08:00
2020-07-02 22:16:53 +08:00
| [See the gif above ](#demo )
2020-03-27 04:56:27 +08:00
2020-07-02 22:16:53 +08:00
## Documentation
2019-12-03 00:17:16 +08:00
2020-05-27 18:03:23 +08:00
Now that your MeiliSearch server is up and running, you can learn more about how to tune your search engine in [the documentation ](https://docs.meilisearch.com ).
2019-12-03 00:17:16 +08:00
2019-11-26 21:23:56 +08:00
## Contributing
2019-10-09 22:39:09 +08:00
2020-03-26 18:59:40 +08:00
Hey! We're glad you're thinking about contributing to MeiliSearch! If you think something is missing or could be improved, please open issues and pull requests. If you'd like to help this project grow, we'd love to have you! To start contributing, checking [issues tagged as "good-first-issue" ](https://github.com/meilisearch/MeiliSearch/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 ) is a good start!
2019-11-22 02:15:33 +08:00
2020-07-02 22:16:53 +08:00
## Telemetry
2019-11-22 02:15:33 +08:00
2020-07-02 22:16:53 +08:00
MeiliSearch collects anonymous data regarding general usage.
2021-02-17 05:21:50 +08:00
This helps us better understand developers usage of MeiliSearch features.
To see what information we're retrieving, please see the complete list [on the dedicated issue ](https://github.com/meilisearch/MeiliSearch/issues/720 ).
We also use Sentry to make us crash and error reports. If you want to know more about what Sentry collects, please visit their [privacy policy website ](https://sentry.io/privacy/ ).
2020-08-28 20:44:53 +08:00
This program is optional, you can disable these analytics by using the `MEILI_NO_ANALYTICS` env variable.
2020-03-26 20:10:44 +08:00
2020-07-02 22:16:53 +08:00
## 💌 Contact
2020-03-26 20:10:44 +08:00
Feel free to contact us about any questions you may have:
2020-07-02 22:16:53 +08:00
* 🆕 Join our [GitHub Discussions forum ](https://github.com/meilisearch/MeiliSearch/discussions )
2020-03-28 17:28:48 +08:00
* Join our [Slack community ](https://slack.meilisearch.com/ ).
2020-03-26 20:10:44 +08:00
* By opening an issue.
2020-07-02 22:16:53 +08:00
MeiliSearch is developed by [Meili ](https://www.meilisearch.com ), a young company. To know more about us, you can [read our blog ](https://blog.meilisearch.com ). Any suggestion or feedback is highly appreciated. Thank you for your support!
