Skip to content

Commit c285c73

Browse files
feat: improve supabase powersync connection docs (#85)
* feat: improve supabase powersync connection docs * Minor tweaks --------- Co-authored-by: benitav <benita@journeyapps.com>
1 parent 185cd00 commit c285c73

File tree

2 files changed

+27
-20
lines changed

2 files changed

+27
-20
lines changed
180 KB
Loading
Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,38 @@
1-
1. In your Supabase Dashboard, click **Connect** in the top bar:
2-
3-
<Frame>
4-
<img src="/images/installation/supabase-connect-database.png" />
5-
</Frame>
1+
1. From your Supabase Dashboard, select **Connect** in the top navigation bar:
62

7-
* Under **Direct connection**, copy the connection string. The hostname should be `db.<PROJECT-ID>.supabase.co`, and not, for example, `aws-0-us-west-1.pooler.supabase.com`.
8-
9-
<Frame>
10-
<img src="/images/installation/supabase-connection-string.png" />
11-
</Frame>
3+
<Frame>
4+
<img src="/images/installation/supabase-connect-database.png" />
5+
</Frame>
6+
7+
* In the **Direct connection** section, copy the complete connection string (including the `[YOUR-PASSWORD]` placeholder)
8+
9+
<Frame>
10+
<img src="/images/installation/supabase-connection-string.png" />
11+
</Frame>
1212

13-
* Paste this URI in PowerSync instance **URI** field.
13+
* Paste the connection string into the PowerSync instance **URI** field. PowerSync will automatically parse this URI to populate the connection details.
1414

15-
* Enter the **Password** for the `postgres` user in your Supabase database.
15+
* For the **Password** field, enter your database's `postgres` user password (this is your database/project password, not your Supabase account password). Need help? Check Supabase's guide on [managing database passwords](https://supabase.com/docs/guides/database/managing-passwords).
1616

17-
* Supabase also [refers to this password](https://supabase.com/docs/guides/database/managing-passwords) as the *database password* or *project password*.
17+
* Note: PowerSync includes Supabase's CA certificate by default, so you can use `verify-full` SSL mode without additional configuration.
18+
19+
Your connection settings should look similar to this:
20+
21+
<Frame>
22+
<img src="/images/integration-guides/powersync-supabase-connection.png" />
23+
</Frame>
1824

19-
* PowerSync has the Supabase CA certificate pre-configured — `verify-full` SSL mode can be used directly, without any custom certificates.
25+
2. Verify your setup by clicking **Test Connection** and resolve any errors.
2026

21-
2. Click **Test Connection** and fix any errors.
27+
3. Configure authentication:
28+
* Navigate to the **Client Auth** tab
29+
* Enable **Use Supabase Auth**
30+
* Enter your Supabase **JWT Secret**
2231

23-
3. Under the **Client Auth** tab, enable **Use Supabase Auth** and enter your Supabase **JWT Secret**:
24-
25-
<Frame caption="PowerSync uses the secret to verify Supabase's JWTs">
32+
<Frame caption="PowerSync will use this secret to validate Supabase JWTs">
2633
<img src="/images/authentication/use-supabase-auth.png" />
2734
</Frame>
2835

29-
4. Click **Save and deploy** to deploy the updates to your instance.
36+
4. Click **Save and deploy** to apply your changes.
3037

31-
PowerSync deploys and configures an isolated cloud environment for you, which will take a few minutes to complete.
38+
PowerSync will now create an isolated cloud environment for your instance. This process typically takes a few minutes.

0 commit comments

Comments
 (0)