1
Step 1Open the server Apps tab
Select the tutorial-vps VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.
Back to all templates
Typesense
Database256MB+ RAM
Fast, typo-tolerant search engine optimized for instant search
searchfull-textinstant-search
Deploy Typesense in 3 Steps
1
Connect Your VPS
Add your server credentials to Server Compass
2
Select Typesense
Choose from our template library
3
Deploy & Configure
Fill in settings and click Deploy
No Docker knowledge required
Step-by-step deployment guide
Deploy Typesense on a VPS with Server Compass
Use the Typesense template in Server Compass to deploy a fast typo-tolerant search engine on your VPS, then verify the health endpoint.
About 10 minutesBrowser verified
2
Step 2Choose an app template
Click New App and choose the template deployment path so Server Compass can load the built-in catalog.
3
Step 3Search for Typesense
Use the template picker search to find Typesense in the Server Compass template catalog.
4
Step 4Select the Typesense template
Choose the Typesense template. Server Compass fills the Typesense container, persistent data volume, HTTP API port, production mode, and generated API key.
5
Step 5Review the Typesense settings
Confirm the app name and compose service. In this run, the app was named typesense-demo and used host port 8108.
6
Step 6Deploy Typesense
Review the generated environment values, confirm the REST and API keys are available, and click Deploy Now.
7
Step 7Watch the deployment progress
Keep the deployment modal open while Server Compass uploads the compose file, pulls the Typesense image, starts the container, and verifies the stack.
8
Step 8Confirm Typesense is running
After deployment finishes, return to the Apps tab and confirm the Typesense app is marked Running with the database port available.
9
Step 9Verify Typesense is reachable
Open the app detail view and verify the running Typesense container. In this tutorial run, the health endpoint reported that Typesense was ready.
After Typesense Opens
- Store the generated Typesense API key in a secure password manager.
- Create scoped API keys before production use.
- Restrict external access to port 8108 unless remote clients explicitly need it.
- Configure regular backups for the Typesense data volume before storing production data.
- Use HTTPS before exposing the Typesense API publicly.
Verified Result
The Typesense REST API returned ready status from a curl request.
Typesense deployment questions
What does the Typesense template deploy?
It deploys a Typesense container with a persistent data volume, HTTP API port, production mode, and generated API key.
Which port did the tutorial use?
The tutorial used host port 8108, which maps to Typesense HTTP API port 8108.
Why is there no browser verification screenshot?
Typesense exposes a service API rather than a conventional browser app. The tutorial verifies it with the health endpoint.
Should this become a blog post?
No. The deployment guide should live on the Typesense template detail page and be linked from the reusable template deployment docs page.
Terminal Deployment
Typesense CLI Deployment
Deploy Typesense the traditional way with SSH and Docker Compose.
1
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
2
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/typesense3
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 key4
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=1005
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:8108Skip 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
1
Create collections
2
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.
Ready to Self-Host Typesense?
Download Server Compass and deploy Typesense to your VPS in under 3 minutes. No Docker expertise required.
Download Server Compass