Typesense

Database256MB+ RAM

Fast, typo-tolerant search engine optimized for instant search

Download Server Compass View Documentation

searchfull-textinstant-search

Deploy Typesense in 3 Steps

Connect Your VPS

Add your server credentials to Server Compass

Select Typesense

Choose from our template library

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required

Terminal Deployment

Typesense CLI Deployment

Deploy Typesense the traditional way with SSH and Docker Compose.

SSH into Your Server

Launch your preferred terminal and connect to your VPS using SSH.

terminal

# Log into your server
ssh root@<your-server-ip>

# If using key-based auth
ssh -i ~/.ssh/my-key root@<your-server-ip>

First time? Docker not installed? Run: curl -fsSL https://get.docker.com | sh

Create Working Directory

Prepare a directory for your application files and configuration.

terminal

# Create and navigate to project directory
mkdir -p ~/apps/typesense
cd ~/apps/typesense

Configure Your Containers

Create the Docker Compose configuration file with these contents:

docker-compose.yml

services:
  typesense:
    image: typesense/typesense:0.25.2
    ports:
      - "8108:8108"
    environment:
      - TYPESENSE_API_KEY=<your-api-key>
      - TYPESENSE_DATA_DIR=/data
    volumes:
      - typesense_data:/data
    restart: unless-stopped

volumes:
  typesense_data:

Deployment Settings

PORTHost port(default: 8108)

API_KEYAPI key

Deploy with Docker Compose

Launch the application stack using Docker Compose.

terminal

# Deploy the application
docker compose up -d

# Check container health
docker compose ps

# Monitor logs
docker compose logs -f --tail=100

Open Required Ports

Enable external access by opening the necessary port.

terminal

# Allow the application port through firewall
sudo ufw allow 8108/tcp
sudo ufw reload

# Access your app at:
# http://your-server-ip:8108

Skip the Terminal

There's an easier way. Meet Server Compass.

Server Compass makes deploying Typesense effortless. Visual setup, one-click deploy, done.

Intuitive dashboard
Deploy in 3 minutes
Free SSL included
Blue-green deploys
Real-time logs
Version history

Download Server Compass$29 one-time • Lifetime license

After Deployment

After deploying Typesense with Server Compass, complete these steps to finish setup

Create collections

Index documents

Need help? Check out our documentation for detailed guides.

Typesense FAQ

Common questions about self-hosting Typesense

How do I deploy Typesense with Server Compass?

Simply download Server Compass, connect to your VPS, and select Typesense from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.

What are the system requirements for Typesense?

Typesense requires a minimum of 256MB RAM. We recommend a VPS with at least 1024MB RAM for optimal performance. Any modern Linux server with Docker support will work.

Can I migrate my existing Typesense data?

Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard Typesense backup and restore procedures.

How do I update Typesense to the latest version?

Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest Typesense image will be pulled and deployed with zero downtime.

Is Typesense free to self-host?

Typesense is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.