1
Step 1Open the server Apps tab
Select your 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
Umami
Application256MB+ RAM
Simple, fast, privacy-focused analytics
analyticsprivacysimple
Deploy Umami in 3 Steps
1
Connect Your VPS
Add your server credentials to Server Compass
2
Select Umami
Choose from our template library
3
Deploy & Configure
Fill in settings and click Deploy
No Docker knowledge required
Step-by-step deployment guide
Deploy Umami on a VPS with Server Compass
Use the Umami template in Server Compass to deploy a self-hosted privacy-focused web analytics app with persistent Fathom SQLite data volume on your VPS, then verify the Umami web UI in a browser.
About 7 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 Umami
Use the template picker search to find Umami in the Server Compass template catalog.
4
Step 4Select the Umami template
Choose the Umami template. Server Compass fills the Umami image, host port, published server URL, and persistent Fathom SQLite data volume.
5
Step 5Review the Umami settings
Confirm the app name and compose services. In this run, the app was named umami-demo and used host port 3000.
6
Step 6Deploy Umami
Review the generated environment values, confirm the port is 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 Umami image, starts the container, and verifies the stack.
8
Step 8Confirm Umami is running
After deployment finishes, return to the Apps tab and confirm the Umami app is marked Running with its application URL available.
9
Step 9Open Umami in the browser
Open the application URL in a browser. The Umami web UI confirms the site is reachable.
After Umami Opens
- Log in with the default Umami administrator, change the password, and add tracked websites before production use.
- Configure websites, tracking snippets, HTTPS, and user access before production use.
- Add a domain and HTTPS before exposing the analytics dashboard to users.
- Back up the Umami PostgreSQL volume before relying on it for production analytics.
Umami deployment questions
What does the Umami template deploy?
It deploys Umami with PostgreSQL for privacy-focused web analytics data and configuration.
Which port did the tutorial use?
The tutorial used host port 3000, which maps to the Umami web server on container port 3000.
Why does the guide stop at the first-run web UI?
The tutorial verifies the clean first-run web UI because real library paths, users, metadata providers, and remote access settings depend on the production server.
Should this become a blog post?
No. The deployment guide should live on the Umami template detail page and be linked from the reusable template deployment docs page.
Manual Setup Guide
Set Up Umami from Terminal
Get your hands dirty: manual Umami deployment guide for developers.
1
Connect to Your VPS via SSH
Fire up your terminal application and establish a connection to your remote server.
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
Initialize Project Folder
Create a folder to house your Docker Compose configuration.
terminal
# Create and navigate to project directory
mkdir -p ~/apps/umami
cd ~/apps/umami3
Create Docker Configuration
Define your services in a docker-compose.yml file:
docker-compose.yml
services:
umami:
image: ghcr.io/umami-software/umami:postgresql-latest
ports:
- "3000:3000"
environment:
- DATABASE_URL=postgresql://umami:<your-db-password>@db:5432/umami
- DATABASE_TYPE=postgresql
- APP_SECRET=<your-app-secret>
restart: unless-stopped
depends_on:
db:
condition: service_healthy
db:
image: postgres:16-alpine
environment:
- POSTGRES_USER=umami
- POSTGRES_PASSWORD=<your-db-password>
- POSTGRES_DB=umami
volumes:
- postgres_data:/var/lib/postgresql/data
restart: unless-stopped
healthcheck:
test: ["CMD-SHELL", "pg_isready -U umami"]
interval: 10s
timeout: 5s
retries: 5
volumes:
postgres_data:
Environment Variables
PORTHost port(default: 3000)APP_SECRETApp secretDB_PASSWORDDB password4
Execute the Deployment
Start your containers and verify they're running correctly.
terminal
# Launch the stack
docker compose up -d
# Verify container status
docker compose ps
# Follow the logs
docker compose logs --follow5
Allow Network Access
Update UFW rules to allow traffic on the application port.
terminal
# Allow the application port through firewall
sudo ufw allow 3000/tcp
sudo ufw reload
# Access your app at:
# http://your-server-ip:3000Skip the Terminal
Don't want to type commands? We've got you.
Why type commands when you can click? Deploy Umami the easy way with Server Compass.
- 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 Umami with Server Compass, complete these steps to finish setup
1
Create account
2
Add websites to track
Need help? Check out our documentation for detailed guides.
Umami FAQ
Common questions about self-hosting Umami
How do I deploy Umami with Server Compass?
Simply download Server Compass, connect to your VPS, and select Umami 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 Umami?
Umami 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 Umami data?
Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard Umami backup and restore procedures.
How do I update Umami to the latest version?
Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest Umami image will be pulled and deployed with zero downtime.
Is Umami free to self-host?
Umami 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 Umami?
Download Server Compass and deploy Umami to your VPS in under 3 minutes. No Docker expertise required.
Download Server Compass