Skip to content

Commit

Permalink
Add links to Meilisearch Cloud (#2627)
Browse files Browse the repository at this point in the history
* add links to meilisearch cloud

* prefer meilisearch.com/cloud for general links

* final adjustments

* Apply suggestions from code review

Co-authored-by: Thomas Payet <thomas@meilisearch.com>

---------

Co-authored-by: Thomas Payet <thomas@meilisearch.com>
  • Loading branch information
guimachiavelli and tpayet authored Nov 20, 2023
1 parent 723b39e commit 67d5a89
Show file tree
Hide file tree
Showing 13 changed files with 31 additions and 41 deletions.
2 changes: 1 addition & 1 deletion home.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Learn how to use Meilisearch in your projects by exploring our guides and API re
content: 'Announcing Meilisearch Cloud: the best way to add Meilisearch to your project',
icon: 'cloud',
size: 2,
link: 'https://www.meilisearch.com/pricing?utm_campaign=oss&utm_source=docs&utm_medium=home-page'
link: 'https://www.meilisearch.com/cloud?utm_campaign=oss&utm_source=docs&utm_medium=home-page'
},
{
content:
Expand Down
16 changes: 4 additions & 12 deletions learn/cookbooks/running_production.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,11 @@ description: Deploy Meilisearch in a Digital Ocean droplet. Covers installation,

# Running Meilisearch in production

## A quick introduction
[Meilisearch Cloud](https://www.meilisearch.com/cloud?utm_campaign=oss&utm_source=docs&utm_medium=running-production-oss) is the recommended way to run Meilisearch in production environments. However, it is also possible to self-host Meilisearch.

Hopefully, you already know that [Meilisearch](https://github.com/meilisearch/meilisearch) is a powerful and fast open-source search engine built in [Rust](https://www.rust-lang.org). It was designed to provide users with a very useful and customizable search experience including out-of-the-box features such as typo-tolerance, filtering, and synonyms for any kind of project.
This tutorial will guide you through setting up a Debian server, installing Meilisearch, and setting up your environment.

Running a Meilisearch instance for testing purposes is incredibly easy and can be done in [many ways](/learn/getting_started/quick_start): using Docker, Homebrew, Aptitude, binaries, a simple `curl`, or even the source code. If you are new to Meilisearch, we suggest that you take a tour around the documentation.

Using Meilisearch on your own machine for your weekend project is fun, let's agree on that. However, you may want to go live and deploy a project in production, to take it to the next level. What steps and details would you need to **deploy Meilisearch in production** and ensure it is **safe and ready to use**?

## Get your Meilisearch ready for production

For this tutorial, we will be using a Debian 10 server, running on DigitalOcean. You can easily try it on your own, with plans starting at $5/month. And if you want some credits to start running your Meilisearch and are not already registered on DigitalOcean, you can get $100 for free using [this referral link](https://m.do.co/c/7c67bd97e101).

## Prerequisites
## Requirements

+ An up-to-date server that runs Debian 10
+ An ssh key pair to connect to that machine
Expand All @@ -28,7 +20,7 @@ Learn how to connect via SSH to your [DigitalOcean droplet](https://www.digitalo

## Step 1: Install Meilisearch

Installing and running Meilisearch is easy and straightforward. In order to keep this tutorial as simple as possible, let's use a script that will carry out the installation process. It will copy a binary of Meilisearch to your machine and enable you to use it immediately.
To keep this tutorial as simple as possible, let's use a script that will carry out the installation process. It will copy a binary of Meilisearch to your machine and enable you to use it immediately.

Once you are logged in into your machine via SSH, ensure your system and its dependencies are up-to-date before proceeding with the installation.

Expand Down
2 changes: 1 addition & 1 deletion learn/experimental/vector_search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Vector search is an experimental technology that uses Large Languag

# Vector search

Vector search is an experimental technology that uses Large Language Models to retrieve search results. This feature is useful when you are interested in results based on the meaning and context of a query, such as suggesting related products in webshop or articles in an online magazine.
Vector search is an experimental technology that uses Large Language Models to retrieve search results. This feature is useful when you are interested in results based on the meaning and context of a query, such as suggesting related products in webshop or articles in an online magazine. [Meilisearch Cloud](https://www.meilisearch.com/cloud?utm_campaign=oss&utm_source=docs&utm_medium=vector-search) is the most robust way of using vector search.

[Visit the GitHub discussion to learn how to get started with vector search in Meilisearch](https://github.com/meilisearch/product/discussions/621).

Expand Down
4 changes: 2 additions & 2 deletions learn/getting_started/cloud_quick_start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ description: Learn how to create your first Meilisearch Cloud project.

# Getting started with Meilisearch Cloud

This tutorial walks you through setting up Meilisearch Cloud, creating a project and an index, adding documents to it, and performing your first search with the default web interface.
This tutorial walks you through setting up [Meilisearch Cloud](https://meilisearch.com/cloud?utm_campaign=oss&utm_source=docs&utm_medium=cloud-quick-start), creating a project and an index, adding documents to it, and performing your first search with the default web interface.

You need a Meilisearch Cloud account to follow along. If you don't have one, register for a 14-day free trial account at [https://cloud.meilisearch.com/register](https://cloud.meilisearch.com/register).
You need a Meilisearch Cloud account to follow along. If you don't have one, register for a 14-day free trial account at [https://cloud.meilisearch.com/register](https://cloud.meilisearch.com/register?utm_campaign=oss&utm_source=docs&utm_medium=cloud-quick-start).

## Creating a project

Expand Down
12 changes: 6 additions & 6 deletions learn/getting_started/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ sidebarDepth: 3

You can install Meilisearch locally or deploy it over a cloud service.

### Meilisearch Cloud

[Meilisearch Cloud](https://www.meilisearch.com/cloud?utm_campaign=oss&utm_source=docs&utm_medium=installation-guide) greatly simplifies installing, maintaining, and updating Meilisearch. [Get started with a 14-day free trial](https://cloud.meilisearch.com/register?utm_campaign=oss&utm_source=docs&utm_medium=installation-guide).

Take a look at our [Meilisearch Cloud tutorial](/learn/getting_started/cloud_quick_start) for more information on setting up and using Meilisearch's cloud service.

### Local installation

<Tabs.Container labels={["cURL", "Homebrew", "Docker", "APT", "Source", "Windows", "Direct download"]}>
Expand Down Expand Up @@ -152,12 +158,6 @@ chmod +x meilisearch

</Tabs.Container>

### Meilisearch Cloud

[Meilisearch Cloud](https://www.meilisearch.com/pricing?utm_campaign=oss&utm_source=docs&utm_medium=installation-guide) greatly simplifies installing, maintaining, and updating Meilisearch. [Get started with a 14-day free trial](https://www.meilisearch.com/pricing?utm_campaign=oss&utm_source=docs&utm_medium=installation-guide).

Take a look at our [Meilisearch Cloud tutorial](/learn/getting_started/cloud_quick_start) for more information on setting up and using Meilisearch's cloud service.

### Cloud deploy

To deploy Meilisearch on a cloud service, follow one of our dedicated guides:
Expand Down
2 changes: 1 addition & 1 deletion learn/getting_started/quick_start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ First, you need to download and install Meilisearch. This command installs the l
curl -L https://install.meilisearch.com | sh
```

The rest of this guide assumes you are using Meilisearch locally, but you may also use Meilisearch over a cloud service such as [Meilisearch Cloud](https://www.meilisearch.com/pricing?utm_campaign=oss&utm_source=docs&utm_medium=quick-start).
The rest of this guide assumes you are using Meilisearch locally, but you may also use Meilisearch over a cloud service such as [Meilisearch Cloud](https://www.meilisearch.com/cloud?utm_campaign=oss&utm_source=docs&utm_medium=quick-start).

Learn more about other installation options in the [installation guide](/learn/getting_started/installation).

Expand Down
2 changes: 2 additions & 0 deletions learn/getting_started/search_preview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Meilisearch comes with a built-in search interface for quick testin

# Search preview

Whether you are using [Meilisearch Cloud](https://www.meilisearch.com/cloud?utm_campaign=oss&utm_source=docs&utm_medium=search-preview) or self-hosting Meilisearch, you can use the search preview for quick manual tests.

After adding documents to your Meilisearch instance, you can immediately start searching through your dataset using Meilisearch's search preview. This can be useful when you want to check that documents have been properly indexed and Meilisearch is working as expected.

If your Meilisearch instance does not have any indexes, you should see this screen.
Expand Down
6 changes: 3 additions & 3 deletions learn/primary_db_sync/meilisync_mysql.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ description: Learn how to keep Meilisearch up to date with your MySQL database.

# Syncing databases with MySQL and meilisync

Though Meilisearch is a database, it is not recommended you use it as your primary data store. Instead, you should use an external database to store your data and periodically synchronise it with Meilisearch.
Though Meilisearch is a database, it is not recommended you use it as your primary data store. Instead, you should use an external database to store your data and periodically synchronize it with Meilisearch.

This guide teaches you to use [`meilisync`](https://github.com/long2ice/meilisync) to keep Meilisearch up to date with a MySQL database.

## Requirements

- A command-line console, such as macOS's terminal or Window's Cygwin
- A MySQL database populated with data
- A Meilisearch instance, either self-hosted or via [Meilisearch Cloud](https://cloud.meilisearch.com)
- A Meilisearch instance, either managed via [Meilisearch Cloud](https://meilisearch.com/cloud?utm_campaign=oss&utm_source=docs&utm_medium=meilisync) or self-hosted

## Install `meilisync`

Expand Down Expand Up @@ -96,7 +96,7 @@ meilisearch:
</Tabs.Content>
</Tabs.Container>

Replace `MEILISEARCH_API_KEY` with an API key able to create, update, and delete documents and indexes. Replace `MEILISEARCH_API_URL` with your instance's API URL. If you are using [Meilisearch Cloud](https://cloud.meilisearch.com), this URL should look similar to this: https://ms-4d85L33tC0d3-5041.fra.meilisearch.io
Replace `MEILISEARCH_API_KEY` with an API key able to create, update, and delete documents and indexes. Replace `MEILISEARCH_API_URL` with your instance's API URL. If you are using [Meilisearch Cloud](https://cloud.meilisearch.com?utm_campaign=oss&utm_source=docs&utm_medium=meilisync), this URL should look similar to this: https://ms-4d85L33tC0d3-5041.fra.meilisearch.io

## Configure MySQL

Expand Down
6 changes: 3 additions & 3 deletions learn/primary_db_sync/meilisync_postgresql.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ description: Learn how to keep Meilisearch up to date with your PostgreSQL datab

# Syncing databases with PostgreSQL and meilisync

Though Meilisearch is a database, it is not recommended you use it as your primary data store. Instead, you should use an external database to store your data and periodically synchronise it with Meilisearch.
Though Meilisearch is a database, it is not recommended you use it as your primary data store. Instead, you should use an external database to store your data and periodically synchronize it with Meilisearch.

This guide teaches you to use [`meilisync`](https://github.com/long2ice/meilisync) to keep Meilisearch up to date with a PostgreSQL database.

## Requirements

- A command-line console, such as macOS's terminal or Window's Cygwin
- A PostgreSQL database populated with data
- A Meilisearch instance, either self-hosted or via [Meilisearch Cloud](https://cloud.meilisearch.com)
- A Meilisearch instance, either self-hosted or via [Meilisearch Cloud](https://meilisearch.com/cloud?utm_campaign=oss&utm_source=docs&utm_medium=meilisync)

## Install `meilisync`

Expand Down Expand Up @@ -94,7 +94,7 @@ meilisearch:
</Tabs.Content>
</Tabs.Container>

Replace `MEILISEARCH_API_KEY` with an API key able to create, update, and delete documents and indexes. Replace `MEILISEARCH_API_URL` with your instance's API URL. If you are using [Meilisearch Cloud](https://cloud.meilisearch.com), this URL should look similar to this: https://ms-4d85L33tC0d3-5041.fra.meilisearch.io
Replace `MEILISEARCH_API_KEY` with an API key able to create, update, and delete documents and indexes. Replace `MEILISEARCH_API_URL` with your instance's API URL. If you are using [Meilisearch Cloud](https://cloud.meilisearch.com?utm_campaign=oss&utm_source=docs&utm_medium=meilisync), this URL should look similar to this: https://ms-4d85L33tC0d3-5041.fra.meilisearch.io

## Configure PostgreSQL

Expand Down
4 changes: 2 additions & 2 deletions learn/security/master_api_keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ This guide will teach you how to protect your Meilisearch instance by setting a

## Protecting a Meilisearch instance

**By default, Meilisearch's API is unprotected**. This means all routes are publicly accessible and require no authorization to access.
**By default, Meilisearch's API is unprotected in self-hosted instances**. This means all routes are publicly accessible and require no authorization to access. If you are using [Meilisearch Cloud](https://cloud.meilisearch.com?utm_campaign=oss&utm_source=docs&utm_medium=api-keys), your instance is protected by default.

To protect a Meilisearch instance from unauthorized use, you must supply a master key at launch. This master key must be at least 16 bytes, composed of valid UTF-8 characters. In a production environment, Meilisearch will throw an error and refuse to launch if no master key is provided or if it is under 16 bytes, Meilisearch will suggest a secure autogenerated master key.
To protect a self-hosted Meilisearch instance from unauthorized use, you must supply a master key at launch. This master key must be at least 16 bytes, composed of valid UTF-8 characters. In a production environment, Meilisearch will throw an error and refuse to launch if no master key is provided or if it is under 16 bytes, Meilisearch will suggest a secure autogenerated master key.

<Capsule intent="warning">
You need to set a master key to access the [`/keys`](/reference/api/keys) route. Otherwise, you will get a [`missing_master_key`](/reference/errors/error_codes#missing_master_key) error.
Expand Down
2 changes: 1 addition & 1 deletion learn/update_and_migration/migrating_cloud.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Once you have successfully migrated your data to Meilisearch Cloud, use the proj

## Create a Meilisearch Cloud project and import dump

Navigate to Meilisearch Cloud in your browser and log in. If you don't have a Meilisearch Cloud account yet, [create one for free](https://cloud.meilisearch.com/register).
Navigate to Meilisearch Cloud in your browser and log in. If you don't have a Meilisearch Cloud account yet, [create one for free](https://cloud.meilisearch.com/register?utm_campaign=oss&utm_source=docs&utm_medium=migration-guide).

You can only import dumps into new Meilisearch Cloud projects. If this is your first time using Meilisearch Cloud, create a new project by clicking on the "Create a project" button. Otherwise, click on the "New project" button:

Expand Down
6 changes: 3 additions & 3 deletions learn/what_is_meilisearch/comparison_to_alternatives.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,8 @@ Can't find a client you'd like us to support? [Submit your idea or vote for it](
|---|:---:|:----:|:---:|:---:|
| Self-hosted |||||
| Official 1-click deploy | ✅ <br /> [DigitalOcean](https://marketplace.digitalocean.com/apps/meilisearch) <br /> [Platform.sh](https://console.platform.sh/projects/create-project?template=https://raw.githubusercontent.com/platformsh/template-builder/master/templates/meilisearch/.platform.template.yaml) <br /> [Azure](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fcmaneu%2Fmeilisearch-on-azure%2Fmain%2Fmain.json) <br /> [Railway](https://railway.app/new/template/TXxa09?referralCode=YltNo3) <br /> [Koyeb](https://app.koyeb.com/deploy?type=docker&image=getmeili/meilisearch&name=meilisearch-on-koyeb&ports=7700;http;/&env%5BMEILI_MASTER_KEY%5D=REPLACE_ME_WITH_A_STRONG_KEY) || 🔶 <br />Only for the cloud-hosted solution ||
| Official cloud-hosted solution | [Meilisearch Cloud](https://www.meilisearch.com/pricing?utm_campaign=oss&utm_source=docs&utm_medium=comparison-table) ||||
| High availability | Available with [Meilisearch Cloud](https://www.meilisearch.com/pricing?utm_campaign=oss&utm_source=docs&utm_medium=comparison-table) ||||
| Official cloud-hosted solution | [Meilisearch Cloud](https://www.meilisearch.com/cloud?utm_campaign=oss&utm_source=docs&utm_medium=comparison-table) ||||
| High availability | Available with [Meilisearch Cloud](https://www.meilisearch.com/cloud?utm_campaign=oss&utm_source=docs&utm_medium=comparison-table) ||||
| Run-time dependencies | None | N/A | None | None |
| Backward compatibility || N/A |||
| Upgrade path | Documents are automatically reindexed on upgrade | N/A | Documents are automatically reindexed on upgrade | Documents are automatically reindexed on upgrade, up to 1 major version |
Expand Down Expand Up @@ -193,7 +193,7 @@ Additionally, Meilisearch is written in Rust, a modern systems-level programming

The [pricing model for Algolia](https://www.algolia.com/pricing/) is based on the number of records kept and the number of API operations performed. It can be prohibitively expensive for small and medium-sized businesses.

Meilisearch is **open-source** and can be **self-hosted**, but also offers a cloud-hosted product analogous to Algolia's service: [Meilisearch Cloud](https://cloud.meilisearch.com/register). Like Algolia, [pricing of Meilisearch Cloud](https://www.meilisearch.com/pricing?utm_campaign=oss&utm_source=docs&utm_medium=comparison) is based on the number of records stored and the number of search operations performed. However, Meilisearch offers a more generous free tier that allows more documents to be stored as well as fairer pricing for search usage. Meilisearch also offers a Pro tier for larger use cases to allow for more predictable pricing.
Meilisearch is an **open-source** search engine available via [Meilisearch Cloud](https://meilisearch.com/cloud?utm_campaign=oss&utm_source=docs&utm_medium=comparison) or self-hosted. Unlike Algolia, [Meilisearch pricing](https://www.meilisearch.com/pricing?utm_campaign=oss&utm_source=docs&utm_medium=comparison) is based on the number of documents stored and the number of search operations performed. However, Meilisearch offers a more generous free tier that allows more documents to be stored as well as fairer pricing for search usage. Meilisearch also offers a Pro tier for larger use cases to allow for more predictable pricing.

## A quick look at the search engine landscape

Expand Down
8 changes: 2 additions & 6 deletions learn/what_is_meilisearch/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,9 @@ description: Meilisearch is a search engine featuring a blazing fast RESTful sea

Meilisearch is a **RESTful search API**. It aims to be a **ready-to-go solution** for everyone who wants a **fast and relevant search experience** for their end-users ⚡️🔎

Efficient search engines often require a significant investment of resources. They are only accessible to companies with the means necessary to develop a bespoke search solution that fits their needs.
## Meilisearch Cloud

Small-to-medium-sized businesses commonly resort to subpar search engines that incur invisible costs on their user experience and retention due to poor search fulfillment.

That's why we created Meilisearch: An open source solution accessible to everyone, designed to meet a vast majority of needs. Requiring very little configuration to be installed, yet highly customizable.

Our solution delivers an **instant search experience** including **typo handling**, **filters**, **custom rankings**, and many more [features](#features). Read on to learn more.
[Meilisearch Cloud](https://www.meilisearch.com/cloud?utm_campaign=oss&utm_source=docs&utm_medium=what-is-meilisearch) is the recommended way of using Meilisearch. Using Meilisearch Cloud greatly simplifies installing, maintaining, and updating Meilisearch. [Get started with a 14-day free trial](https://www.meilisearch.com/cloud?utm_campaign=oss&utm_source=docs&utm_medium=what-is-meilisearch).

## Demo

Expand Down

0 comments on commit 67d5a89

Please sign in to comment.