diff --git a/learn/configuration/instance_options.mdx b/learn/configuration/instance_options.mdx index 7946eef72b..5291d02b07 100644 --- a/learn/configuration/instance_options.mdx +++ b/learn/configuration/instance_options.mdx @@ -164,7 +164,6 @@ Designates the location where database files will be created and retrieved. **Default value**: `development`
**Expected value**: `production` or `development` - Configures the instance's environment. Value must be either `production` or `development`. `production`: @@ -188,10 +187,10 @@ When the server environment is set to `development`, providing a master key is n **Default value**: `"localhost:7700"`
**Expected value**: an HTTP address and port - Sets the HTTP address and port Meilisearch will use. ### Master key + **Environment variable**: `MEILI_MASTER_KEY`
**CLI option**: `--master-key`
**Default value**: `None`
diff --git a/learn/contributing/contributing_docs.mdx b/learn/contributing/contributing_docs.mdx index 8a72a044bd..0c4dbcd730 100644 --- a/learn/contributing/contributing_docs.mdx +++ b/learn/contributing/contributing_docs.mdx @@ -23,7 +23,7 @@ The Meilisearch documentation repository only stores the content of the docs web ### Handling images and other static assets -When contributing content to the Meilisearch docs, store screenshots, images, GIFs, and videos in the relevant directory under `/assets`. +When contributing content to the Meilisearch docs, store screenshots, images, GIFs, and videos in the relevant directory under `/assets`. The build process does not currently support static assets with relative paths. When adding them to a document, make sure the asset URL points to the raw GitHub file address: diff --git a/learn/cookbooks/running_production.mdx b/learn/cookbooks/running_production.mdx index 3fa4341b6a..bb7e4093a2 100644 --- a/learn/cookbooks/running_production.mdx +++ b/learn/cookbooks/running_production.mdx @@ -216,7 +216,7 @@ systemctl enable nginx systemctl restart nginx ``` -Meilisearch is now up, deployed in a production environment, using a safe API key, and being served by a Reverse Proxy Nginx. You should now be able to send requests to your server from the outside world. Open your web browser and visit: (http://your-ip-address). The IP address is the same you used to connect to your machine via SSH in Step 1. +Meilisearch is now up, deployed in a production environment, using a safe API key, and being served by a Reverse Proxy Nginx. You should now be able to send requests to your server from the outside world. Open your web browser and visit: `http://your-ip-address`. The IP address is the same you used to connect to your machine via SSH in Step 1. If you want to learn more about using Nginx as a Reverse Proxy, see [this dedicated documentation](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/). diff --git a/learn/cookbooks/search_bar_for_docs.mdx b/learn/cookbooks/search_bar_for_docs.mdx index 598021ee42..60a75d342b 100644 --- a/learn/cookbooks/search_bar_for_docs.mdx +++ b/learn/cookbooks/search_bar_for_docs.mdx @@ -133,15 +133,19 @@ In your VuePress project: + ```bash yarn add vuepress-plugin-meilisearch ``` + + ```bash npm install vuepress-plugin-meilisearch ``` + diff --git a/learn/cookbooks/vercel.mdx b/learn/cookbooks/vercel.mdx index 1f0a148f5e..0d5a8a4e46 100644 --- a/learn/cookbooks/vercel.mdx +++ b/learn/cookbooks/vercel.mdx @@ -25,7 +25,7 @@ From your Vercel dashboard, create a new project. You can create a project from ![Create a new project on Vercel dashboard](https://raw.githubusercontent.com/meilisearch/documentation/main/assets/images/vercel/01.create-new-project-on-vercel-dashboard.png) -Select your project, then click on **Deploy**. Once deployment is complete, go back to your project’s dashboard. +Select your project, then click on **Deploy**. Once deployment is complete, go back to your project’s dashboard. ### Add the Meilisearch integration @@ -57,7 +57,7 @@ Once you click on **Create project**, you should see the following message: “Y ### Understand and use Meilisearch API keys -Meilisearch creates two default API keys: [`Default Search API Key` and `Default Admin API Key`](/learn/security/master_api_keys#using-default-api-keys-for-authorization). +Meilisearch creates two default API keys: [`Default Search API Key` and `Default Admin API Key`](/learn/security/master_api_keys#using-default-api-keys-for-authorization). #### Admin API key @@ -76,6 +76,7 @@ The master key–which hasn’t been added to Vercel–grants users full control ### Review your project settings Go back to your project settings and check the new Meilisearch environment variables: + - `MEILISEARCH_ADMIN_KEY` - `MEILISEARCH_URL` - `MEILISEARCH_SEARCH_KEY` @@ -94,6 +95,6 @@ Use the [Meilisearch Cloud dashboard](https://cloud.meilisearch.com/projects/?ut ## Resources and next steps -Check out the [quick start guide](/learn/getting_started/quick_start#add-documents) for a short introduction on how to use Meilisearch. We also provide many [SDKs and tools](/learn/what_is_meilisearch/sdks), so you can use Meilisearch in your favorite language or framework. +Check out the [quick start guide](/learn/getting_started/quick_start#add-documents) for a short introduction on how to use Meilisearch. We also provide many [SDKs and tools](/learn/what_is_meilisearch/sdks), so you can use Meilisearch in your favorite language or framework. You are now ready to [start searching](/reference/api/search)! diff --git a/learn/experimental/metrics.mdx b/learn/experimental/metrics.mdx index 38baddc553..7fa8bb4127 100644 --- a/learn/experimental/metrics.mdx +++ b/learn/experimental/metrics.mdx @@ -15,4 +15,4 @@ Are you using this feature? Meilisearch wants to hear from you! Tell us about yo `/metrics` is an experimental feature. Experimental features are unstable: their API might significantly change and become incompatible between releases. Meilisearch does not recommend using experimental features in a production environment. Meilisearch makes experimental features available expecting they will become stable in a future release. However, it is not possible to guarantee when and if this will happen. - \ No newline at end of file + diff --git a/learn/experimental/overview.mdx b/learn/experimental/overview.mdx index be24d0f086..753e5f6aff 100644 --- a/learn/experimental/overview.mdx +++ b/learn/experimental/overview.mdx @@ -5,16 +5,16 @@ description: Activate and configure Meilisearch experimental features. Meilisear # Experimental features -Meilisearch periodically introduces new experimental features. Experimental features are not always ready for production, but offer functionality that might benefit some users. -Consult each experimental feature's dedicated page for more information on its recommended usage. +Meilisearch periodically introduces new experimental features. Experimental features are not always ready for production, but offer functionality that might benefit some users. Consult each experimental feature's dedicated page for more information on its recommended usage. -An experimental feature's API can change significantly and become incompatible between releases. Keep this in mind when using experimental features in a production environment. +An experimental feature's API can change significantly and become incompatible between releases. Keep this in mind when using experimental features in a production environment. Meilisearch makes experimental features available expecting they will become stable in a future release, but this is not guaranteed. ## Activating experimental features Experimental features fall into two groups based on how they are activated or deactivated: + 1. Those that are activated at launch with a command-line flag or environment variable 2. Those that are activated with the [`/experimental-features` API route](/reference/api/experimental_features). diff --git a/learn/front_end/front_end_integration.mdx b/learn/front_end/front_end_integration.mdx index 5bb4b3898d..52b7551bba 100644 --- a/learn/front_end/front_end_integration.mdx +++ b/learn/front_end/front_end_integration.mdx @@ -18,4 +18,4 @@ Using [`instant-meilisearch`](https://github.com/meilisearch/instant-meilisearch -You should now have a working front-end search interface. [Consult `instant-meilisearch`'s documentation for more information on how to further customize your search interface.](https://github.com/meilisearch/instant-meilisearch) \ No newline at end of file +You should now have a working front-end search interface. [Consult `instant-meilisearch`'s documentation for more information on how to further customize your search interface.](https://github.com/meilisearch/instant-meilisearch) diff --git a/learn/getting_started/cloud_quick_start.mdx b/learn/getting_started/cloud_quick_start.mdx index 9b7695e982..6f78368059 100644 --- a/learn/getting_started/cloud_quick_start.mdx +++ b/learn/getting_started/cloud_quick_start.mdx @@ -77,6 +77,6 @@ If you can see the results coming in as you type, congratulations: you now know ## What's next -This tutorial taught you how to use Meilisearch Cloud's interface to create a project, add an index to it, and use the search preview interface. +This tutorial taught you how to use Meilisearch Cloud's interface to create a project, add an index to it, and use the search preview interface. -In most real-life settings, you will be creating your own search interface and retrieving results through Meilisearch's API. To learn how to add documents and search using the command-line or an SDK in your preferred language, check out the [Meilisearch quick start](/learn/getting_started/quick_start). \ No newline at end of file +In most real-life settings, you will be creating your own search interface and retrieving results through Meilisearch's API. To learn how to add documents and search using the command-line or an SDK in your preferred language, check out the [Meilisearch quick start](/learn/getting_started/quick_start). diff --git a/learn/getting_started/quick_start.mdx b/learn/getting_started/quick_start.mdx index e4bd52b048..b62cc8929d 100644 --- a/learn/getting_started/quick_start.mdx +++ b/learn/getting_started/quick_start.mdx @@ -29,7 +29,6 @@ The rest of this guide assumes you are using Meilisearch locally, but you may al Learn more about other installation options in the [installation guide](/learn/getting_started/installation). - ### Running Meilisearch Next, launch Meilisearch by running the following command in your terminal: diff --git a/learn/getting_started/search_preview.mdx b/learn/getting_started/search_preview.mdx index 32752452f3..229a31050d 100644 --- a/learn/getting_started/search_preview.mdx +++ b/learn/getting_started/search_preview.mdx @@ -23,4 +23,4 @@ You can add a dataset containing many popular movies to an instance: Once indexing finishes, you can access `http://localhost:7700` and confirm everything is working correctly by searching for "The Truman Show:" -![Animated gif in which a user types "trumen show" and sees "The Truman Show" as the top result](https://raw.githubusercontent.com/meilisearch/documentation/main/assets/images/search_preview/trumen.gif) \ No newline at end of file +![Animated gif in which a user types "trumen show" and sees "The Truman Show" as the top result](https://raw.githubusercontent.com/meilisearch/documentation/main/assets/images/search_preview/trumen.gif) diff --git a/learn/index_settings/synonyms.mdx b/learn/index_settings/synonyms.mdx index 7f92d6c3ef..be07850364 100644 --- a/learn/index_settings/synonyms.mdx +++ b/learn/index_settings/synonyms.mdx @@ -109,7 +109,6 @@ Multi-word synonyms follow a different set of rules than single-word synonyms: - Meilisearch treats multi-word synonyms as [phrases](/reference/api/search#phrase-search-2) - Multi-word synonyms are limited to a maximum of three words - #### Example Suppose you set `San Francisco` and `SF` as synonyms with a [mutual association](#mutual-association) diff --git a/learn/inner_workings/known_limitations.mdx b/learn/inner_workings/known_limitations.mdx index 948b194ee2..a98f6c091c 100644 --- a/learn/inner_workings/known_limitations.mdx +++ b/learn/inner_workings/known_limitations.mdx @@ -149,4 +149,3 @@ user = 1 OR (user = 2 AND user = 3) OR (user = 4 AND user = 5) OR user = 6 **Limitation:** When [searching for facet values](/reference/api/facet_search), Meilisearch returns a maximum of 100 facets. **Explanation:** the limit to the maximum number of returned facets has been implemented to offer a good balance between usability and comprehensive results. Facet search allows users to filter a large list of facets so they may quickly find categories relevant to their query. This is different from searching through an index of documents. Faceting index settings such as `maxValuesPerFacet` limit the have no impact in facet search and only affect queries searching through documents. - diff --git a/learn/primary_db_sync/meilisync_mysql.mdx b/learn/primary_db_sync/meilisync_mysql.mdx index 5889e2ccda..d606584686 100644 --- a/learn/primary_db_sync/meilisync_mysql.mdx +++ b/learn/primary_db_sync/meilisync_mysql.mdx @@ -21,6 +21,7 @@ Install `meilisync` to the same location as your primary database. You can do th + ### Docker First, create a `docker-compose.yml` file in your Docker project directory. Open it with a text editor and add the following content: @@ -47,6 +48,7 @@ After a few seconds, Docker will inform you it has successfully pulled `meilisyn + ### Manual install First, make sure you have Python 3.9 and `pip` installed. @@ -76,6 +78,7 @@ Create a `config.yml` file in your project's directory. Open it with a text edit + ```yaml meilisearch: api_url: http://host.docker.internal:7700/ @@ -83,9 +86,11 @@ meilisearch: insert_size: 1000 insert_interval: 10 ``` + + ```yaml meilisearch: api_url: MEILISEARCH_API_URL @@ -93,10 +98,11 @@ meilisearch: insert_size: 1000 insert_interval: 10 ``` + -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), this URL should look similar to this: `https://ms-4d85L33tC0d3-5041.fra.meilisearch.io` ## Configure MySQL @@ -162,15 +168,19 @@ With the configuration done, open your command-line prompt once again and run `m - ```sh - docker-compose up - ``` + +```sh +docker-compose up +``` + - ```sh - meilisync start - ``` + +```sh +meilisync start +``` + diff --git a/learn/primary_db_sync/meilisync_postgresql.mdx b/learn/primary_db_sync/meilisync_postgresql.mdx index 73cbcfccf8..e074b25a68 100644 --- a/learn/primary_db_sync/meilisync_postgresql.mdx +++ b/learn/primary_db_sync/meilisync_postgresql.mdx @@ -21,6 +21,7 @@ Install `meilisync` to the same location as your primary database. You can do th + ### Docker First, create a `docker-compose.yml` file in your Docker project directory. Open it with a text editor and add the following content: @@ -46,6 +47,7 @@ After a few seconds, Docker will inform you it has successfully pulled `meilisyn + ### Manual install First, make sure you have Python 3.9 and `pip` installed. @@ -74,6 +76,7 @@ Create a `config.yml` file in your project's directory. Open it with a text edit + ```yaml meilisearch: api_url: http://host.docker.internal:7700/ @@ -81,9 +84,11 @@ meilisearch: insert_size: 1000 insert_interval: 10 ``` + + ```yaml meilisearch: api_url: MEILISEARCH_API_URL @@ -91,10 +96,11 @@ meilisearch: insert_size: 1000 insert_interval: 10 ``` + -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), this URL should look similar to this: `https://ms-4d85L33tC0d3-5041.fra.meilisearch.io` ## Configure PostgreSQL @@ -161,9 +167,7 @@ sync: Replace `POSTGRES_TABLE_NAME_1` and `MEILISEARCH_INDEX_NAME_1` with the names of your tables and indexes. As the above example demonstrates, you may sync multiple tables. - This tutorial describes a fairly basic `meilisync` setup. For more - customization options, consult [`meilisync`'s - documentation](https://github.com/long2ice/meilisync#configuration). +This tutorial describes a fairly basic `meilisync` setup. For more customization options, consult [`meilisync`'s documentation](https://github.com/long2ice/meilisync#configuration). ## Run `meilisync` @@ -172,15 +176,19 @@ With the configuration done, open your command-line prompt once again and run `m - ```sh - docker-compose up - ``` + +```sh +docker-compose up +``` + - ```sh - meilisync start - ``` + +```sh +meilisync start +``` + diff --git a/learn/update_and_migration/migrating_cloud.mdx b/learn/update_and_migration/migrating_cloud.mdx index e80e835455..03cf71d06e 100644 --- a/learn/update_and_migration/migrating_cloud.mdx +++ b/learn/update_and_migration/migrating_cloud.mdx @@ -57,4 +57,4 @@ Meilisearch Cloud automatically generates a new master key during project creati Once your project is ready, click on it to enter the project overview. From there, click on "Search preview" in the top bar menu. This will bring you to the search preview interface. Run a few test searches to ensure all data was migrated successfully. -Congratulations, you have now migrated to Meilisearch Cloud, the recommended way to use Meilisearch. If you encountered any problems during this process, reach out to our support team on [Discord](https://discord.gg/meilisearch). \ No newline at end of file +Congratulations, you have now migrated to Meilisearch Cloud, the recommended way to use Meilisearch. If you encountered any problems during this process, reach out to our support team on [Discord](https://discord.gg/meilisearch). diff --git a/learn/update_and_migration/previous_docs_version.mdx b/learn/update_and_migration/previous_docs_version.mdx index f6274111d7..79dde132fe 100644 --- a/learn/update_and_migration/previous_docs_version.mdx +++ b/learn/update_and_migration/previous_docs_version.mdx @@ -59,7 +59,7 @@ The site search bar is not functional in local copies of the documentation websi ### >= v1.2: read `.mdx` files -Starting with v1.2, Meilisearch's documentation content and build code live in separate repositories. Because of this, it is not possible to run a local copy of the documentation website. +Starting with v1.2, Meilisearch's documentation content and build code live in separate repositories. Because of this, it is not possible to run a local copy of the documentation website. To access the Meilisearch documentation for versions 1.2 and later, read the `.mdx` files directly, either locally with the help of a modern text editor or remotely using GitHub's interface. diff --git a/learn/update_and_migration/updating.mdx b/learn/update_and_migration/updating.mdx index 82fc05b419..1644d8ee80 100644 --- a/learn/update_and_migration/updating.mdx +++ b/learn/update_and_migration/updating.mdx @@ -175,6 +175,7 @@ The response will vary slightly depending on your version. For v0.27 and below, -H 'Authorization: Bearer API_KEY' # -H 'X-Meili-API-Key: API_KEY' for v0.24 or below ``` + Once the `dumpCreation` task shows `"status": "succeeded"`, you're ready to move on. diff --git a/learn/what_is_meilisearch/comparison_to_alternatives.mdx b/learn/what_is_meilisearch/comparison_to_alternatives.mdx index 2aa80ec580..0e4e4aa233 100644 --- a/learn/what_is_meilisearch/comparison_to_alternatives.mdx +++ b/learn/what_is_meilisearch/comparison_to_alternatives.mdx @@ -241,7 +241,6 @@ Elasticsearch is a search engine based on the Lucene library and is most popular Today, Lucene and Elasticsearch are dominant players in the search engine landscape. They both are solid solutions for a lot of different use cases in search, and also for building your own recommendation engine. They are good general products, but they require to be configured properly to get similar results to those of Meilisearch or Algolia. - ### Closed source #### Algolia diff --git a/learn/what_is_meilisearch/overview.mdx b/learn/what_is_meilisearch/overview.mdx index 6feb95826a..6c7225771c 100644 --- a/learn/what_is_meilisearch/overview.mdx +++ b/learn/what_is_meilisearch/overview.mdx @@ -56,4 +56,3 @@ Meilisearch provides an intuitive search-as-you-type experience with response ti Instead of showing you examples, why not just invite you to test Meilisearch interactively in the **out-of-the-box search preview** we deliver? There's no need to write a single line of front-end code. All you need to do is follow [this guide](/learn/getting_started/quick_start) to give the search engine a try! - diff --git a/reference/api/experimental_features.mdx b/reference/api/experimental_features.mdx index b32a0f8494..8594907f01 100644 --- a/reference/api/experimental_features.mdx +++ b/reference/api/experimental_features.mdx @@ -27,7 +27,6 @@ The experimental API route is not compatible with all experimental features. Con | **`scoreDetails`** | Boolean | `true` if feature is active, `false` otherwise | | **`vectorSearch`** | Boolean | `true` if feature is active, `false` otherwise | - ## Get all experimental features @@ -70,4 +69,4 @@ Setting a field to `null` leaves its value unchanged. "scoreDetails": true, "vectorSearch": false } -``` \ No newline at end of file +``` diff --git a/reference/api/search.mdx b/reference/api/search.mdx index dd1458fa45..c48c78da19 100644 --- a/reference/api/search.mdx +++ b/reference/api/search.mdx @@ -971,4 +971,3 @@ The following query returns documents whose `overview` includes `"adventure"`: Results would not include documents containing `"adventure"` in other fields such as `title` or `genre`, even if these fields were present in the `searchableAttributes` list. - diff --git a/reference/api/settings.mdx b/reference/api/settings.mdx index 0e72869530..08d790e434 100644 --- a/reference/api/settings.mdx +++ b/reference/api/settings.mdx @@ -229,6 +229,7 @@ User-defined dictionaries can be used together with synonyms. It can be useful t "W.E.B.": ["W. E. B."] } ``` + ### Get dictionary @@ -253,7 +254,7 @@ Get an index's user-defined dictionary. [] ``` -### Update dictionary +### Update dictionary @@ -636,7 +637,7 @@ You can use the returned `taskUid` to get more details on [the status of the tas ### Reset faceting settings -Reset an index's faceting settings to their [default value](#faceting-object). Setting `sortFacetValuesBy` to `null`(` --data-binary '{ "sortFacetValuesBy": null }'`), will restore it to the default value (`"*": "alpha"`). +Reset an index's faceting settings to their [default value](#faceting-object). Setting `sortFacetValuesBy` to `null`(`--data-binary '{ "sortFacetValuesBy": null }'`), will restore it to the default value (`"*": "alpha"`). #### Path parameters