7691b0d721
1636: Hotfix: Log but don't panic when vergen can't retrieve commit information r=curquiza a=Kerollmops This pull request fixes an issue we discovered when we tried to publish meilisearch v0.21 on brew, brew uses the tarball downloaded from github directly which doesn't contain the `.git` folder. We use the `.git` folder with [vergen](https://docs.rs/vergen) to retrieve the commit and datetime information. Unfortunately, we were unwrapping the vergen result and it was crashing when the git folder was missing. We no more panic when vergen can't find the `.git` folder and just log out a potential error returned by [the git2 library](https://docs.rs/git2). We then just check that the env variables are available at compile-time and replace it with "unknown" if not. ### When the `.git` folder is available ``` xh localhost:7700/version HTTP/1.1 200 OK Content-Type: application/json Date: Thu, 26 Aug 2021 13:44:23 GMT Transfer-Encoding: chunked { "commitSha": "81a76eab69944de8a8d5006345b5aec7b02acf50", "commitDate": "2021-08-26T13:41:30+00:00", "pkgVersion": "0.21.0" } ``` ### When the `.git` folder is unavailable ```bash cp -R meilisearch meilisearch-cpy cd meilisearch-cpy rm -rf .git cargo clean cargo run --release <snip> Compiling meilisearch-http v0.21.0 (/Users/clementrenault/Documents/meilisearch-cpy/meilisearch-http) warning: vergen: could not find repository from '/Users/clementrenault/Documents/meilisearch-cpy/meilisearch-http'; class=Repository (6); code=NotFound (-3) ``` ``` xh localhost:7700/version HTTP/1.1 200 OK Content-Type: application/json Date: Thu, 26 Aug 2021 13:46:33 GMT Transfer-Encoding: chunked { "commitSha": "unknown", "commitDate": "unknown", "pkgVersion": "0.21.0" } ``` Co-authored-by: Kerollmops <clement@meilisearch.com>
MeiliSearch
Website | Roadmap | Blog | LinkedIn | Twitter | Documentation | FAQ
⚡ Lightning Fast, Ultra Relevant, and Typo-Tolerant Search Engine 🔍
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. For more information about features go to our documentation.
✨ Features
- Search-as-you-type experience (answers < 50 milliseconds)
- Full-text search
- Typo tolerant (understands typos and misspelling)
- Faceted search and filters
- Supports hanzi (Chinese characters)
- Supports synonyms
- Easy to install, deploy, and maintain
- Whole documents are returned
- Highly customizable
- RESTful API
Getting started
Deploy the Server
Homebrew (Mac OS)
brew update && brew install meilisearch
meilisearch
Docker
docker run -p 7700:7700 -v "$(pwd)/data.ms:/data.ms" getmeili/meilisearch
Try MeiliSearch in our Sandbox
Create a MeiliSearch instance in MeiliSearch Sandbox. This instance is free, and will be active for 48 hours.
Run on Digital Ocean
Deploy on Platform.sh
APT (Debian & Ubuntu)
echo "deb [trusted=yes] https://apt.fury.io/meilisearch/ /" > /etc/apt/sources.list.d/fury.list
apt update && apt install meilisearch-http
meilisearch
Download the binary (Linux & Mac OS)
curl -L https://install.meilisearch.com | sh
./meilisearch
Compile and run it from sources
If you have the latest stable Rust toolchain installed on your local system, clone the repository and change it to your working directory.
git clone https://github.com/meilisearch/MeiliSearch.git
cd MeiliSearch
cargo run --release
Create an Index and Upload Some Documents
Let's create an index! If you need a sample dataset, use this movie database. You can also find it in the datasets/ directory.
curl -L 'https://bit.ly/2PAcw9l' -o movies.json
Now, you're ready to index some data.
curl -i -X POST 'http://127.0.0.1:7700/indexes/movies/documents' \
--header 'content-type: application/json' \
--data-binary @movies.json
Search for Documents
In command line
The search engine is now aware of your documents and can serve those via an HTTP server.
The jq command-line tool can greatly help you read the server responses.
curl 'http://127.0.0.1:7700/indexes/movies/search?q=botman+robin&limit=2' | jq
{
"hits": [
{
"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, Batman battles the dual threat of frosty genius Mr. Freeze and homicidal horticulturalist Poison Ivy. Freeze plans to put Gotham City on ice, while Ivy tries to drive a wedge between the dynamic duo.",
"release_date": 866768400
},
{
"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. Featuring the voices of Adam West, Burt Ward, and Julie Newmar, the film sees the superheroes going up against classic villains like The Joker, The Riddler, The Penguin and Catwoman, both in Gotham City… and in space.",
"release_date": 1475888400
}
],
"nbHits": 8,
"exhaustiveNbHits": false,
"query": "botman robin",
"limit": 2,
"offset": 0,
"processingTimeMs": 2
}
Use the Web Interface
We also deliver an out-of-the-box web interface in which you can test MeiliSearch interactively.
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. All you need to do is open your web browser and enter MeiliSearch’s address to visit it. This will lead you to a web page with a search bar that will allow you to search in the selected index.
Documentation
Now that your MeiliSearch server is up and running, you can learn more about how to tune your search engine in the documentation.
Contributing
Hey! We're glad you're thinking about contributing to MeiliSearch! However, we are currently working on a huge refactor and accepting PRs on this repository wouldn't be productive. We are sorry about this! Be sure we are doing our best so that you can contribute to MeiliSearch again as soon as possible ❤️
Telemetry
MeiliSearch collects anonymous data regarding general usage. 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.
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.
This program is optional, you can disable these analytics by using the MEILI_NO_ANALYTICS env variable.
💌 Contact
Feel free to contact us with any questions you may have:
- 🆕 Join our GitHub Discussions forum
- Join our Slack community.
- By opening an issue.
MeiliSearch is developed by Meili, a young company. To know more about us, you can read our blog. Any suggestion or feedback is highly appreciated. Thank you for your support!