Skip to main content

Supabase Setup

This guide walks you through creating and configuring a Supabase project for your BYOK deployment.

Prerequisites​

  • A Supabase account (sign up at supabase.com)
  • A Supabase Pro plan or higher is recommended for production use (includes daily backups and point-in-time recovery)

Step 1: Create a New Project​

  1. Log in to the Supabase Dashboard
  2. Click New Project
  3. Choose your organization (or create one)
  4. Enter a project name (e.g., your company name)
  5. Set a strong database password - store this securely, you will need it for direct database access
  6. Select your region - see the region selection guidance below

Region Selection​

Supabase offers regions across multiple continents. Choose the region closest to your primary user base for the best performance. If you have data residency requirements (e.g., GDPR requiring EU data storage), select a region that satisfies those constraints.

Available region categories:

  • North America: US East, US West, Canada
  • Europe: EU West, EU Central, UK
  • Asia Pacific: Singapore, Sydney, Tokyo, Mumbai
  • Middle East: Bahrain

Your data will reside exclusively in the region you select. NearSync has no ability to move or replicate your data to other regions.

Step 2: Note Your Project Credentials​

Once the project is created, navigate to Settings > API in the Supabase Dashboard. You will need:

  • Project URL - the HTTPS endpoint for your Supabase project
  • Anon (public) key - the public API key used by the NearSync frontend. This key is safe to expose in client-side code because all data access is governed by Row-Level Security policies.
  • Service role key - the privileged key used only during one-time schema setup. This key bypasses RLS and should be treated as a secret. After NearSync runs the initial migration, you should rotate this key.

Keep these credentials ready for the onboarding process.

Step 3: Enable Required Extensions​

NearSync uses the pgvector extension for AI-powered features (RAG knowledge base, semantic search). The migration script enables this automatically, but you can verify it is available:

  1. Go to Database > Extensions in the Supabase Dashboard
  2. Search for vector
  3. Confirm it is available (it is enabled by default on Supabase Pro plans)

Step 4: Configure Authentication​

NearSync uses Supabase Auth for user management. The default configuration works out of the box, but you may want to review these settings under Authentication > Providers:

  • Email provider is required (enabled by default)
  • Email confirmations - NearSync handles invitation-based signups; review your confirmation email preferences
  • Password requirements - set minimum password length and complexity to match your organization's policy

Redirect URLs​

Under Authentication > URL Configuration, add the domains where your NearSync deployment will be hosted:

  • Your admin dashboard domain
  • Your client portal domain
  • http://localhost:3005 and http://localhost:3010 for local development (optional)

Step 5: Configure Storage​

NearSync uses Supabase Storage for file uploads (documents, contracts, images, brand assets). The schema migration creates the required storage buckets automatically. No manual storage configuration is needed.

Step 6: Provide Credentials During Onboarding​

During the onboarding call with the NearSync team:

  1. Navigate to the Setup tab in your NearSync client portal
  2. Enter your Supabase project URL and keys
  3. NearSync runs the one-time schema migration
  4. Verify the migration completed successfully
  5. Rotate your service role key in the Supabase Dashboard under Settings > API

After this step, NearSync no longer has access to your privileged database key.

FeatureFreeProTeam
Daily backupsNoYesYes
Point-in-time recoveryNoYesYes
8 GB database spaceNoYesYes
Email supportNoYesYes
SOC 2 Type IIYesYesYes

For production BYOK deployments, the Pro plan is the minimum recommendation. It provides automated backups, which are your responsibility in the BYOK model.

Next Steps​

Once your Supabase project is ready, proceed to: