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
SuperTokens
Development512MB+ RAM
Open-source authentication with prebuilt UI
authsessionauthentication
Deploy SuperTokens in 3 Steps
1
Connect Your VPS
Add your server credentials to Server Compass
2
Select SuperTokens
Choose from our template library
3
Deploy & Configure
Fill in settings and click Deploy
No Docker knowledge required
Step-by-step deployment guide
Deploy SuperTokens on a VPS with Server Compass
Use the SuperTokens template in Server Compass to deploy the self-hosted SuperTokens Core API with Postgres on your VPS, then verify the API responds 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 SuperTokens
Use the template picker search to find SuperTokens in the Server Compass template catalog.
4
Step 4Select the SuperTokens template
Choose the SuperTokens template. Server Compass fills the SuperTokens Core service and Postgres password.
5
Step 5Review the SuperTokens settings
Confirm the app name and compose services. In this run, the app was named supertokens-demo and used host port 3567.
6
Step 6Deploy SuperTokens
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 SuperTokens image, starts the container, and verifies the stack.
8
Step 8Confirm SuperTokens is running
After deployment finishes, return to the Apps tab and confirm the SuperTokens app is marked Running with its Core API URL available.
9
Step 9Open the SuperTokens Core API
Open the Core API health endpoint in a browser. A successful response confirms the stack is reachable.
After SuperTokens Opens
- Connect your backend SDK to the SuperTokens Core API URL and configure app-specific auth recipes.
- Add an API key, reverse proxy, domain, and HTTPS before exposing SuperTokens outside a private network.
- Configure email delivery, social providers, and session settings in the application code that uses SuperTokens.
- Back up the SuperTokens Postgres volume before relying on it for production identity data.
Verified Result
The SuperTokens Core API responded successfully in a browser.
SuperTokens deployment questions
What does the SuperTokens template deploy?
It deploys SuperTokens with a Postgres database service.
Which port did the tutorial use?
The tutorial verified SuperTokens on host port 3567, which maps to the SuperTokens Core service on container port 3567.
Why does the guide verify an API endpoint instead of a web UI?
SuperTokens Core is an authentication API service. Your frontend and backend applications provide the user-facing screens.
Should this become a blog post?
No. The deployment guide should live on the SuperTokens template detail page and be linked from the reusable template deployment docs page.
Command Line Setup
Install SuperTokens Manually
Set up SuperTokens yourself using Docker Compose and the command line.
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/supertokens
cd ~/apps/supertokens3
Create Docker Configuration
Define your services in a docker-compose.yml file:
docker-compose.yml
services:
supertokens:
image: supertokens/supertokens-postgresql:latest
ports:
- "3567:3567"
environment:
- POSTGRESQL_CONNECTION_URI=postgresql://supertokens:<your-db-password>@db:5432/supertokens
restart: unless-stopped
depends_on:
db:
condition: service_healthy
db:
image: postgres:16-alpine
environment:
- POSTGRES_USER=supertokens
- POSTGRES_PASSWORD=<your-db-password>
- POSTGRES_DB=supertokens
volumes:
- postgres_data:/var/lib/postgresql/data
restart: unless-stopped
healthcheck:
test: ["CMD-SHELL", "pg_isready -U supertokens"]
interval: 10s
timeout: 5s
retries: 5
volumes:
postgres_data:
Configuration Options
PORTHost port(default: 3567)DB_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 3567/tcp
sudo ufw reload
# Access your app at:
# http://your-server-ip:3567Skip the Terminal
Don't want to type commands? We've got you.
No terminal needed. Deploy SuperTokens through a visual dashboard with automatic configuration.
- 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 SuperTokens with Server Compass, complete these steps to finish setup
1
Test core API
2
Set up frontend SDK
3
Configure recipes
Need help? Check out our documentation for detailed guides.
SuperTokens FAQ
Common questions about self-hosting SuperTokens
How do I deploy SuperTokens with Server Compass?
Simply download Server Compass, connect to your VPS, and select SuperTokens 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 SuperTokens?
SuperTokens requires a minimum of 512MB 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 SuperTokens data?
Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard SuperTokens backup and restore procedures.
How do I update SuperTokens to the latest version?
Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest SuperTokens image will be pulled and deployed with zero downtime.
Is SuperTokens free to self-host?
SuperTokens 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.
Related Templates
View all Development
PocketBase
Open-source backend in a single file with realtime database, auth, and file storage
Appwrite
Open-source backend-as-a-service - self-hosted Firebase alternative
Parse Server
Open-source backend framework with dashboard
Supabase
Full Supabase self-hosted with Kong, GoTrue Auth, Realtime, and Studio
Ready to Self-Host SuperTokens?
Download Server Compass and deploy SuperTokens to your VPS in under 3 minutes. No Docker expertise required.
Download Server Compass