Skip to content

Commit

Permalink
Shorten installation guide (#2644)
Browse files Browse the repository at this point in the history
  • Loading branch information
guimachiavelli authored Dec 13, 2023
1 parent 5814678 commit 5067c74
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 32 deletions.
5 changes: 5 additions & 0 deletions config/sidebar-learn.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
]
},
Expand Down
37 changes: 5 additions & 32 deletions learn/getting_started/installation.mdx
Original file line number Diff line number Diff line change
@@ -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

<Tabs.Container labels={["cURL", "Homebrew", "Docker", "APT", "Source", "Windows", "Direct download"]}>

Expand Down Expand Up @@ -158,7 +155,7 @@ chmod +x meilisearch

</Tabs.Container>

### Cloud deploy
## Other cloud services

To deploy Meilisearch on a cloud service, follow one of our dedicated guides:

Expand All @@ -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.

Expand Down Expand Up @@ -272,27 +269,3 @@ chmod +x meilisearch
</Tabs.Content>

</Tabs.Container>

## 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.
36 changes: 36 additions & 0 deletions learn/getting_started/supported_os.mdx
Original file line number Diff line number Diff line change
@@ -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.

<Capsule intent="tip">
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.
</Capsule>

## 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.

0 comments on commit 5067c74

Please sign in to comment.