Follow this step-by-step guide to set up suparbase and sync your first database. You'll be up and running in under 5 minutes.
Before you begin, make sure you have:
A Supabase account with at least one database
Database connection string from Supabase
Basic understanding of databases (helpful but not required)
A modern web browser (Chrome, Firefox, Safari, or Edge)
Sign up for a free suparbase account. No credit card required.
Steps to Follow
Go to the signup page
Enter your email and create a password
Verify your email address
You're ready to go!
Connect your Supabase database to suparbase.
Steps to Follow
Click "Add Connection" in the dashboard
Enter a name for your connection (e.g., "Production DB")
Select environment type (development, staging, or production)
Paste your Supabase connection string
Click "Test Connection" to verify
Example
postgresql://postgres:[YOUR-PASSWORD]@db.[PROJECT-REF].supabase.co:5432/postgresVerify that suparbase can connect to your database.
Steps to Follow
After adding a connection, click "Test Connection"
Wait for the connection test to complete
Green checkmark means you're good to go!
If it fails, check your connection string and network settings
Set up a sync job between two databases.
Steps to Follow
Navigate to "Sync Jobs" → "Create New Sync"
Select your source database (where data comes from)
Select your target database (where data goes to)
Choose tables to sync (or sync all)
Review the schema comparison
Click "Create Sync"
Track sync progress and manage your databases.
Steps to Follow
View sync status in real-time
Check sync history and logs
Set up email notifications
Manage your connections
Explore your database schema
Connection string format
Make sure your connection string includes the password and uses the correct port (5432).
Network/firewall restrictions
Ensure your database allows connections from suparbase servers. Check Supabase network settings.
Schema incompatibilities
Use schema validation before syncing. Fix incompatible changes in your source database first.
Large table syncs
For large tables, sync in smaller batches or during off-peak hours to avoid timeouts.
Now that you've set up your first sync, explore advanced features like schema synchronization, keep-alive configuration, and usage monitoring.