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 via Homebrew

Mac Binary

Linux Binary

Docker

Docker Compose

docker-compose up

DEB package on Ubuntu/Debian

RPM package on CentOS/RHEL

Windows (WSL) (opens new window)

🎬 Start

From Homebrew on macOS

For macOS running on Intel:

• The default API key is xyz and the default port is 8108
• The config file is at /usr/local/etc/typesense/typesense.ini
• Logs are under /usr/local/var/log/typesense/
• Data dir is under /usr/local/var/lib/typesense/

For macOS running on Apple silicon:

• The default API key is xyz and the default port is 8108
• The config file is at /opt/homebrew/etc/typesense/typesense.ini
• Logs are under /opt/homebrew/var/log/typesense/
• Data dir is under /opt/homebrew/var/lib/typesense/

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:

• The config file is at /etc/typesense/typesense-server.ini
  • The admin API key is auto-generated and can be found inside the config file.
• Logs are under /var/log/typesense/
• Data dir is under /var/lib/typesense/

Windows 10 (WSL)

Typesense server can be started by logging into WSL and executing the below given command.

You can retrieve the hostname for the server on which Typesense is running using wsl hostname -I in cmd. You should be able to connect to this hostname/IP address directly from Windows.

If you'd like Typesense to be started at startup, you can create a BAT file with the command powershell.exe /c wsl.exe sudo /usr/bin/./typesense-server --config=/etc/typesense/typesense-server.ini and set it to execute at startup.

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

TIP

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.