meilisearch/cloud-scripts

Cloud scripts for cloud provider agnostic configuration

Website | Roadmap | Meilisearch Cloud | Blog | Documentation | FAQ | Discord

⚡ A lightning-fast search engine that fits effortlessly into your apps, websites, and workflow 🔍

Meilisearch helps you shape a delightful search experience in a snap, offering features that work out-of-the-box to speed up your workflow.

🔥 Try it! 🔥

✨ Features

• Search-as-you-type: find search results in less than 50 milliseconds
• Typo tolerance: get relevant matches even when queries contain typos and misspellings
• Filtering and faceted search: enhance your users' search experience with custom filters and build a faceted search interface in a few lines of code
• Sorting: sort results based on price, date, or pretty much anything else your users need
• Synonym support: configure synonyms to include more relevant content in your search results
• Geosearch: filter and sort documents based on geographic data
• Extensive language support: search datasets in any language, with optimized support for Chinese, Japanese, Hebrew, and languages using the Latin alphabet
• Security management: control which users can access what data with API keys that allow fine-grained permissions handling
• Multi-Tenancy: personalize search results for any number of application tenants
• Highly Customizable: customize Meilisearch to your specific needs or use our out-of-the-box and hassle-free presets
• RESTful API: integrate Meilisearch in your technical stack with our plugins and SDKs
• Easy to install, deploy, and maintain

📖 Documentation

You can consult Meilisearch's documentation at https://www.meilisearch.com/docs.

🚀 Getting started

For basic instructions on how to set up Meilisearch, add documents to an index, and search for documents, take a look at our Quick Start guide.

⚡ Supercharge your Meilisearch experience

Say goodbye to server deployment and manual updates with Meilisearch Cloud. No credit card required.

🧰 SDKs & integration tools

Install one of our SDKs in your project for seamless integration between Meilisearch and your favorite language or framework!

Take a look at the complete Meilisearch integration list.

⚙️ Advanced usage

Experienced users will want to keep our API Reference close at hand.

We also offer a wide range of dedicated guides to all Meilisearch features, such as filtering, sorting, geosearch, API keys, and tenant tokens.

Finally, for more in-depth information, refer to our articles explaining fundamental Meilisearch concepts such as documents and indexes.

📊 Telemetry

Meilisearch collects anonymized data from users to help us improve our product. You can deactivate this whenever you want.

To request deletion of collected data, please write to us at [email protected]. Don't forget to include your Instance UID in the message, as this helps us quickly find and delete your data.

If you want to know more about the kind of data we collect and what we use it for, check the telemetry section of our documentation.

📫 Get in touch!

Meilisearch is a search engine created by Meili, a software development company based in France and with team members all over the world. Want to know more about us? Check out our blog!

🗞 Subscribe to our newsletter if you don't want to miss any updates! We promise we won't clutter your mailbox: we only send one edition every two months.

💌 Want to make a suggestion or give feedback? Here are some of the channels where you can reach us:

• For feature requests, please visit our product repository
• Found a bug? Open an issue!
• Want to be part of our Discord community? Join us!

Thank you for your support!

👩‍💻 Contributing

Meilisearch is, and will always be, open-source! If you want to contribute to the project, please take a look at our contribution guidelines.

📦 Versioning

Meilisearch releases and their associated binaries are available in this GitHub page.

The binaries are versioned following SemVer conventions. To know more, read our versioning policy.

Differently from the binaries, crates in this repository are not currently available on crates.io and do not follow SemVer conventions.

cloud-scripts's Issues

Dev UI is disabled forever after choosing prod in meilisearch-setup

I run meilisearch-setup second time after set up on digital ocean and expect that chosing n option should switch the environment to the development allowing the access to the UI. At the moment it does not.

To Reproduce

1. setup using digital ocean described here
2. run meilisearch-setup and choose production option
3. run meilisearch-setup again and choose dev option
4. the UI is not available

Expected behavior
UI should be available

Desktop (please complete the following information):

• OS: MacOS
• Browser: firefox, safari

Add .editorconfig file

To unify the basic styling rules, please add an .editorconfig file like those ones:

https://github.com/meilisearch/meilisearch-kubernetes/blob/master/.editorconfig
https://github.com/meilisearch/meilisearch-python/blob/master/.editorconfig

Warning: invalid local UTF-8 at the end of the `meilisearch-setup` script

Description
A Warning message appears at the end of the meilisearch-setup script.
The command gives by the warning or an export should fix the problem and should be added to the cloud-config.yaml.

Screenshots or Logs

_____________________________________________________________________
WARNING! Your environment specifies an invalid locale.
 The unknown environment variables are:
   LC_CTYPE=UTF-8 LC_ALL=
 This can affect your user experience significantly, including the
 ability to manage packages. You may install the locales by running:

   sudo apt-get install language-pack-UTF-8
     or
   sudo locale-gen UTF-8

To see all available language packs, run:
   apt-cache search "^language-pack-[a-z][a-z]$"
To disable this message for all users, run:
   sudo touch /var/lib/cloud/instance/locale-check.skip
_____________________________________________________________________

Revert the creation and the configuration of the meilisearch user

This is meant to simplify the removal of the ssh commands (#37 ), the cleaning ot the meilisearch-clous repositories and prepare a potential fix where the ssh keys for the user meilisearch are not copied when a user creates a meilisearch machine through a provider.

Issues on the meilisearch-cloud repositories :

• DigitalOcean(NO NEED)
• AWS
• GCP

`meilisearch.service` file on AWS AMI using wrong Environment

On the AWS AMI, in the /etc/systemd/system/meilisearch.service file, you find the following:

Environment="MEILI_SERVER_PROVIDER=digital_ocean"

Obviously this should be AWS

Create a meilisearch user. Avoid using root for user access

The root user will be used by installation and configuration of an instance, but the final user should access the instance with a custom meilsiearch user.

Related to meilisearch/meilisearch-digitalocean#72

Undefined path for the dumps/ folder

Currently, when creating a dump, the dumps folder path is undefined and depends on the system meilisearch is running. systemd seems to create it at the root, but when we run meilisearch on a local machine it's in the same directory as MeiliSearch binary. The dumps folder path should be defined by an env variable in the service, and should be consistent among different services :)

Add slack link instead of email for support (MOTD)!

In the Message Of The Day for MeiliSearch official image on DO, the "support" information shouldn't point to an email address, but to our Slack Community!

Create CONTRIBUTING.md

Create a CONTRIBUTING.md file with detailed instructions on how to contribute to the project, bump MeiliSearch version and release process.

Set bigger client_max_body_size for Nginx

MeilISearch max payload is being changed by default to 100M in meilisearch/meilisearch#1147. This should be reflected by the nginx .conf by adding

client_max_body_size 100M;

at http in

/etc/nginx/nginx.conf

This modification should be documented somewhere :)

Make `systemctl` restart `Meilisearch` if it has been killed

Description
Meilisearch doesn't restart after being killed.

Basic example
A restart of the binary could be handled by the systemctl configuration

These two lines should be added in each provider yaml file in the content of this file /etc/systemd/system/meilisearch.service

Restart=on-failure
RestartSec=5s

[Bugfix] Fix grammatical issue

Description
Very minor grammatical error

Create access to meilisearch user on first boot

Deploy meilisearch through the cloud-config.yaml

In order to get rid of the ssh commands launched after the creation of the machine on the meilisearch-digitalocean, meilisearch-gcp and meilisearch-aws, we would need to deploy meilisearch through the cloud-config.yaml.

This issue is here to test this option and centralize the issues from the other repositories.

What needs to be looked :

• For each provider, the command to launch the deploy-meilisearch.sh will differ.
  curl https://raw.githubusercontent.com/meilisearch/cloud-scripts/{0}/scripts/deploy-meilisearch.sh | sudo bash -s {0} {1} where {0} is the version and {1} is the provider
• For DO, we would need to launch the cleanup.sh

Issues on the meilisearch-cloud repositories :

• DigitalOcean
• AWS
• GCP (TODO if conluant on DO)

Create README

Create a README with the MeilISearch format, explaining the repo content.

Remove or specify analytics for CI/tests in cloud-repositories

When launching the CI tests or testing in meilisearch-digitalocean, meilisearch-aws or meilisearch-gcp, the MeiliSearch instances that are launched either when creating the image or testing it has analytics specifying the provider.

It would be nice if we could disable the analytics while doing the CI/tests or specify that it comes from the CI/tests (for CI/tests monitoring for example).

The MeiliSearch configuration is located at cloud-scripts/providers/{provider}/cloud-config.yaml

The analytics and the MEILI_SERVER_PROVIDER still need to be set when creating the final image that will be released, because that's the MeiliSearch that will be used by future users.

Use `'` instead of `"` in our scripts for literal strings

We should use ' instead of " in our scripts for literal strings.

Ex:

MEILISEARCH_ENVIRONMENT="development"

should be

MEILISEARCH_ENVIRONMENT='development'

Change digital ocean image naming to include rc number

When generating a digital ocean image the naming looks like this:

MeiliSearch-v0.22.0-rc-Debian-10.3

Since there is no rc number we have to remember which rc image it is and delete it to create the more recent rc's.

This may lead to images with the wrong rc without us knowing.

Set provider in ENV for analytitcs

Currently the Cloud provider for analytics is set in the service file as "digital_ocean" as seen here

As this is used for several providers now, this information should come from the environment at build time

• DigitalOcean
• AWS
• GCP

Create global alias for MeiliSearch configuration script

Configuration script is currently run with the command:

sh /var/opt/meilisearch/scripts/first-login/000-set-meili-env.sh

This is a bad idea because:

• No readability
• Impossible to remeber
• No maintainability: script could easily change location or name and command will be modified

A generic alias (for all users) can be created in /etc/profile.d making meilisearch-setup the generic command to run