# Install Typesense

Here are a couple of available options to install and run Typesense.

# Option 1: Typesense Cloud

The easiest way to run Typesense is using our managed Cloud service called Typesense Cloud (opens new window).

  • Sign-in with Github
  • Pick a configuration and click on Launch. You'll have a ready-to-use cluster in a few minutes.
  • Then click on "Generate API Key", which will give you the hostnames and API keys to use in your code.

# Option 2: Local Machine / Self-Hosting

You can also run Typesense on your local machine or self-host it.

You'll find DEB, RPM and pre-built binaries for Linux (X86_64) and macOS on our downloads (opens new window) page.

We also publish official Docker images for Typesense on Docker hub (opens new window).

# 📥 Download & Install

# Mac Binary

# Linux Binary

# Docker

# DEB package on Ubuntu/Debian

# RPM package on CentOS/RHEL

# 🎬 Start

# From the pre-built binary

If you downloaded the pre-built binary for Mac / Linux, you can start Typesense with minimal options like this:

# From the Docker image

If you want to use Docker, you can run Typesense like this:

# From DEB / RPM package

If you had installed Typesense from a DEB/RPM package, the Typesense server is automatically started as a systemd service when installation is complete. You can check the status via:

By default, Typesense will start on port 8108, and the installation will generate a random API key, which you can view/change from the configuration file at /etc/typesense/typesense-server.ini


We are starting a single node here, but Typesense can also run in a clustered mode. See the High Availability section for more details.

# 🆗 Health Check

You can use the /health API end-point to verify that the server is ready to accept requests.

# ⚙️ Configure Typesense

You can configure various Typesense Server settings using command line arguments. Read this reference article for more information on How To Configure Typesense Server.

Last Updated: 10/7/2021, 10:16:33 AM