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
OpenSearch
Database2048MB+ RAM
Open-source search and analytics suite (Elasticsearch fork)
databasesearchanalyticsopen-source
Deploy OpenSearch in 3 Steps
1
Connect Your VPS
Add your server credentials to Server Compass
2
Select OpenSearch
Choose from our template library
3
Deploy & Configure
Fill in settings and click Deploy
No Docker knowledge required
Step-by-step deployment guide
Deploy OpenSearch on a VPS with Server Compass
Use the OpenSearch template in Server Compass to deploy an open-source search and analytics suite on your VPS, then verify cluster health from inside the container.
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 OpenSearch
Use the template picker search to find OpenSearch in the Server Compass template catalog.
4
Step 4Select the OpenSearch template
Choose the OpenSearch template. Server Compass fills the secured OpenSearch container, persistent data volume, API port, performance port, Dashboards port, heap settings, and generated admin password.
5
Step 5Review the OpenSearch settings
Confirm the app name and compose service. In this run, the app was named opensearch-demo and used host port 9200.
6
Step 6Deploy OpenSearch
Review the generated environment values, keep the admin password masked, confirm the HTTP and performance and dashboard portss 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 OpenSearch image, starts the container, and verifies the stack.
8
Step 8Confirm OpenSearch is running
After deployment finishes, return to the Apps tab and confirm the OpenSearch app is marked Running with the database port available.
9
Step 9Verify OpenSearch is reachable
Open the app detail view and verify the running OpenSearch container. In this tutorial run, the internal cluster health endpoint returned a healthy status without exposing the generated password.
After OpenSearch Opens
- Store the generated admin password in a secure password manager.
- Create application-specific OpenSearch users and roles before production use.
- Restrict external access to port 9200 unless remote clients explicitly need it.
- Configure regular backups for the OpenSearch data volume before storing production data.
- Tune heap size and disk watermarks before production workloads.
Verified Result
The OpenSearch container returned an accepted cluster health status from the internal HTTPS endpoint.
OpenSearch deployment questions
What does the OpenSearch template deploy?
It deploys a secured single-node OpenSearch container with a persistent data volume, API port, performance port, Dashboards port, generated admin password, and configured JVM heap.
Which port did the tutorial use?
The tutorial used host port 9200, which maps to OpenSearch API port 9200. The template also checks the performance and dashboard ports used by OpenSearch internals.
Why is there no browser verification screenshot?
OpenSearch is a service API, not a normal browser application. The tutorial verifies it with an authenticated cluster health request inside the running container.
Should this become a blog post?
No. The deployment guide should live on the OpenSearch template detail page and be linked from the reusable template deployment docs page.
Self-Deploy Guide
DIY OpenSearch Deployment
Learn how to self-host OpenSearch with this hands-on deployment guide.
1
Connect to Your Remote Server
Begin by establishing a secure connection to your server through the terminal.
terminal
# Access your VPS
ssh root@YOUR_SERVER_IP
# With SSH key authentication
ssh -i ~/.ssh/your-private-key root@YOUR_SERVER_IPFirst time? Ensure Docker is installed first: curl -fsSL https://get.docker.com | sh
2
Set Up Your App Folder
Create a dedicated folder for your application files.
terminal
# Create and navigate to project directory
mkdir -p ~/apps/opensearch
cd ~/apps/opensearch3
Set Up Docker Compose
Create the following docker-compose.yml in your project directory:
docker-compose.yml
services:
opensearch:
image: opensearchproject/opensearch:latest
ports:
- "9200:9200"
- "9600:9600"
environment:
- discovery.type=single-node
- OPENSEARCH_INITIAL_ADMIN_PASSWORD=<your-admin-password>
- "OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m"
volumes:
- opensearch_data:/usr/share/opensearch/data
ulimits:
memlock:
soft: -1
hard: -1
restart: unless-stopped
opensearch-dashboards:
image: opensearchproject/opensearch-dashboards:latest
ports:
- "5601:5601"
environment:
- OPENSEARCH_HOSTS=["https://opensearch:9200"]
depends_on:
- opensearch
restart: unless-stopped
volumes:
opensearch_data:
Setup Variables
PORTAPI port(default: 9200)PERF_PORTPerformance port(default: 9600)DASHBOARD_PORTDashboards port(default: 5601)ADMIN_PASSWORDAdmin password4
Spin Up the Stack
Run Docker Compose to launch your application.
terminal
# Launch the stack
docker compose up -d
# Verify container status
docker compose ps
# Follow the logs
docker compose logs --follow5
Open the Application Port
Configure UFW to allow traffic to your application.
terminal
# Allow the application port through firewall
sudo ufw allow 9200/tcp
sudo ufw reload
# Access your app at:
# http://your-server-ip:9200Skip the Terminal
Make it simple with Server Compass.
Let Server Compass handle the complexity. Deploy OpenSearch with a simple, intuitive interface.
- No terminal required
- Point-and-click setup
- Auto SSL certificates
- Rolling deployments
- Health monitoring
- Instant rollbacks
Download Server Compass$29 one-time • Lifetime license
After Deployment
After deploying OpenSearch with Server Compass, complete these steps to finish setup
1
Access Dashboards
2
Login with admin credentials
3
Create indices and set up data ingestion
Need help? Check out our documentation for detailed guides.
OpenSearch FAQ
Common questions about self-hosting OpenSearch
How do I deploy OpenSearch with Server Compass?
Simply download Server Compass, connect to your VPS, and select OpenSearch 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 OpenSearch?
OpenSearch requires a minimum of 2048MB RAM. We recommend a VPS with at least 4096MB RAM for optimal performance. Any modern Linux server with Docker support will work.
Can I migrate my existing OpenSearch data?
Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard OpenSearch backup and restore procedures.
How do I update OpenSearch to the latest version?
Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest OpenSearch image will be pulled and deployed with zero downtime.
Is OpenSearch free to self-host?
OpenSearch 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 OpenSearch?
Download Server Compass and deploy OpenSearch to your VPS in under 3 minutes. No Docker expertise required.
Download Server Compass