From 5067c74ba10406fc6dc04a2dbe3c4f5db475824f Mon Sep 17 00:00:00 2001 From: gui machiavelli Date: Wed, 13 Dec 2023 12:02:04 +0100 Subject: [PATCH] Shorten installation guide (#2644) --- config/sidebar-learn.json | 5 ++++ learn/getting_started/installation.mdx | 37 ++++---------------------- learn/getting_started/supported_os.mdx | 36 +++++++++++++++++++++++++ 3 files changed, 46 insertions(+), 32 deletions(-) create mode 100644 learn/getting_started/supported_os.mdx diff --git a/config/sidebar-learn.json b/config/sidebar-learn.json index c3dec9902d..506f1d8d87 100644 --- a/config/sidebar-learn.json +++ b/config/sidebar-learn.json @@ -53,6 +53,11 @@ "source": "learn/getting_started/search_preview.mdx", "label": "Search preview", "slug": "search_preview" + }, + { + "source": "learn/getting_started/supported_os.mdx", + "label": "Supported operating systems", + "slug": "supported_os" } ] }, diff --git a/learn/getting_started/installation.mdx b/learn/getting_started/installation.mdx index df5d9ae690..f3a55c9e2b 100644 --- a/learn/getting_started/installation.mdx +++ b/learn/getting_started/installation.mdx @@ -1,22 +1,19 @@ --- title: Installation — Meilisearch documentation description: Use Meilisearch with either Meilisearch Cloud, another cloud service, or install it locally. -sidebarDepth: 3 --- -# Installation and operating systems - -## Installation +# Installation You can install Meilisearch locally or deploy it over a cloud service. -### Meilisearch Cloud +## 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 +## Local installation @@ -158,7 +155,7 @@ chmod +x meilisearch -### Cloud deploy +## Other cloud services To deploy Meilisearch on a cloud service, follow one of our dedicated guides: @@ -170,7 +167,7 @@ To deploy Meilisearch on a cloud service, follow one of our dedicated guides: - [Qovery](/learn/cookbooks/qovery) - [Railway](/learn/cookbooks/railway) -### Installing older versions of Meilisearch +## Installing older versions of Meilisearch We discourage the use of older Meilisearch versions. Before installing an older version, please [contact support](https://discord.meilisearch.com) to check if the latest version might work as well. @@ -272,27 +269,3 @@ chmod +x meilisearch - -## Supported operating systems - -This section lists operating systems Meilisearch officially supports and tests with every new release. Meilisearch binaries might still run in unsupported environments. - -If the provided [binaries](/learn/getting_started/installation#local-installation) do not work on your operating system, try building Meilisearch [from source](#local-installation). If compilation fails, Meilisearch is not compatible with your machine. - -### Linux - -The Meilisearch binary works on all Linux distributions with `amd64/x86_64` or `aarch64/arm64` architecture using glibc 2.27 and later. You can check your glibc version using: - -``` -ldd --version -``` - -### macOS - -The Meilisearch binary works with macOS 12 and later with `amd64` or `arm64` architecture. - -### Windows - -The Meilisearch binary works on Windows Server 2022 and later. - -It is likely the Meilisearch binary also works with Windows OS 10 and later. However, due to the differences between Windows OS and Windows Server, Meilisearch does not officially support Windows OS. diff --git a/learn/getting_started/supported_os.mdx b/learn/getting_started/supported_os.mdx new file mode 100644 index 0000000000..36ccf9879f --- /dev/null +++ b/learn/getting_started/supported_os.mdx @@ -0,0 +1,36 @@ +--- +title: Supported operating systems — Meilisearch documentation +description: Meilisearch officially supports Windows, MacOS, and many Linux distributions. +--- + +# Supported operating systems + +Meilisearch officially supports Windows, MacOS, and many Linux distributions. Consult the [installation guide](/learn/getting_started/installation) for more instructions. + +Meilisearch binaries might still run in unsupported environments. + + +Use [Meilisearch Cloud](https://www.meilisearch.com/cloud?utm_campaign=oss&utm_source=docs&utm_medium=supported-os) to integrate Meilisearch with applications hosted in unsupported operating systems. + + +## Linux + +The Meilisearch binary works on all Linux distributions with `amd64/x86_64` or `aarch64/arm64` architecture using glibc 2.27 and later. You can check your glibc version using: + +``` +ldd --version +``` + +## macOS + +The Meilisearch binary works with macOS 12 and later with `amd64` or `arm64` architecture. + +## Windows + +The Meilisearch binary works on Windows Server 2022 and later. + +It is likely the Meilisearch binary also works with Windows OS 10 and later. However, due to the differences between Windows OS and Windows Server, Meilisearch does not officially support Windows OS. + +## Troubleshooting + +If the provided [binaries](https://github.com/meilisearch/meilisearch/releases) do not work on your operating system, try building Meilisearch [from source](/learn/getting_started/installation#local-installation). If compilation fails, Meilisearch is not compatible with your machine. \ No newline at end of file