SuperTokens

Development512MB+ RAM

Open-source authentication with prebuilt UI

Download Server Compass View Documentation

authsessionauthentication

Deploy SuperTokens in 3 Steps

Connect Your VPS

Add your server credentials to Server Compass

Select SuperTokens

Choose from our template library

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required

Command Line Setup

Install SuperTokens Manually

Set up SuperTokens yourself using Docker Compose and the command line.

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_IP

First time? Ensure Docker is installed first: curl -fsSL https://get.docker.com | sh

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/supertokens

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 password

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 --follow

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:3567

Skip 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

Test core API

Set up frontend SDK

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.