diff --git a/images/installation/copy-instance-url.png b/images/installation/copy-instance-url.png new file mode 100644 index 0000000..7d39fe6 Binary files /dev/null and b/images/installation/copy-instance-url.png differ diff --git a/images/installation/create-new-instance.png b/images/installation/create-new-instance.png index 8f8a6b2..4d2c018 100644 Binary files a/images/installation/create-new-instance.png and b/images/installation/create-new-instance.png differ diff --git a/images/installation/edit-instance.png b/images/installation/edit-instance.png new file mode 100644 index 0000000..0e02b29 Binary files /dev/null and b/images/installation/edit-instance.png differ diff --git a/images/installation/overview-connection-details.png b/images/installation/overview-connection-details.png new file mode 100644 index 0000000..f6535ab Binary files /dev/null and b/images/installation/overview-connection-details.png differ diff --git a/images/installation/overview-create-instance.png b/images/installation/overview-create-instance.png new file mode 100644 index 0000000..290f8ea Binary files /dev/null and b/images/installation/overview-create-instance.png differ diff --git a/images/installation/overview-supabase-auth.png b/images/installation/overview-supabase-auth.png new file mode 100644 index 0000000..715ea18 Binary files /dev/null and b/images/installation/overview-supabase-auth.png differ diff --git a/images/installation/overview-sync-rules.png b/images/installation/overview-sync-rules.png new file mode 100644 index 0000000..736437c Binary files /dev/null and b/images/installation/overview-sync-rules.png differ diff --git a/images/installation/update-sync-rules.png b/images/installation/update-sync-rules.png new file mode 100644 index 0000000..10c08bc Binary files /dev/null and b/images/installation/update-sync-rules.png differ diff --git a/images/integration-5.png b/images/integration-5.png deleted file mode 100644 index 923ab8b..0000000 Binary files a/images/integration-5.png and /dev/null differ diff --git a/images/integration-6.png b/images/integration-6.png deleted file mode 100644 index 7e2e65a..0000000 Binary files a/images/integration-6.png and /dev/null differ diff --git a/images/integration-7.png b/images/integration-7.png deleted file mode 100644 index 9cd6fe3..0000000 Binary files a/images/integration-7.png and /dev/null differ diff --git a/images/integration-guides/powersync-supabase-connection.png b/images/integration-guides/powersync-supabase-connection.png deleted file mode 100644 index 3566eb1..0000000 Binary files a/images/integration-guides/powersync-supabase-connection.png and /dev/null differ diff --git a/integration-guides/supabase-+-powersync.mdx b/integration-guides/supabase-+-powersync.mdx index 5435260..8826eac 100644 --- a/integration-guides/supabase-+-powersync.mdx +++ b/integration-guides/supabase-+-powersync.mdx @@ -6,6 +6,7 @@ sidebarTitle: Overview import CreateCloudInstance from '/snippets/create-cloud-instance.mdx'; import SupabaseConnection from '/snippets/supabase-database-connection.mdx'; +import ConfigureSyncRules from '/snippets/configure-sync-rules.mdx'; @@ -118,35 +119,7 @@ create publication powersync for table public.lists, public.todos; ### Configure Sync Rules - -[Sync Rules](/usage/sync-rules) allow developers to control which data gets synced to which user devices using a SQL-like syntax in a YAML file. For the demo app, we're going to specify that each user can only see their own to-do lists and list items. - -1. To update your sync rules, open the `sync-rules.yaml` file. - - - - - -2. Replace the `sync-rules.yaml` file's contents with the below: - -```yaml -bucket_definitions: - user_lists: - # Separate bucket per To-Do list - parameters: select id as list_id from lists where owner_id = request.user_id() - data: - - select * from lists where id = bucket.list_id - - select * from todos where list_id = bucket.list_id -``` - -3. In the top right, click **"Validate sync rules"** and ensure there are no errors. This validates your sync rules against your Postgres database. -4. In the top right, click **"Deploy sync rules"** and select your instance. -5. Confirm in the dialog and wait a couple of minutes for the deployment to complete. - - -- For additional information on PowerSync's Sync Rules, refer to the [Sync Rules](/usage/sync-rules) documentation. -- If you're wondering how Sync Rules relate to Supabase Postgres [RLS](https://supabase.com/docs/guides/auth/row-level-security), see [this subsection](/integration-guides/supabase-+-powersync/rls-and-sync-rules). - + ## Test Everything (Using Our Demo App) @@ -234,7 +207,7 @@ SUPABASE_ANON_KEY=foo 2. For the value of `powersyncUrl`, click the copy icon on your instance to copy its URL: - + #### Run the app diff --git a/snippets/configure-sync-rules.mdx b/snippets/configure-sync-rules.mdx new file mode 100644 index 0000000..cd84817 --- /dev/null +++ b/snippets/configure-sync-rules.mdx @@ -0,0 +1,27 @@ +[Sync Rules](/usage/sync-rules) allow developers to control which data gets synced to which user devices using a SQL-like syntax in a YAML file. For the demo app, we're going to specify that each user can only see their own to-do lists and list items. + +1. The final step is to replace the Sync Rules file's contents with the below: + +```yaml +bucket_definitions: + user_lists: + # Separate bucket per To-Do list + parameters: select id as list_id from lists where owner_id = request.user_id() + data: + - select * from lists where id = bucket.list_id + - select * from todos where list_id = bucket.list_id +``` + + + + + +3. Click **"Validate sync rules"** and ensure there are no errors. This validates your sync rules against your Postgres database. +4. Click **"Save and deploy"** to deploy your Sync Rules. + + +- Your Sync Rules can be updated by navigating to the **Manage instances** workspace and selecting the `sync-rules.yaml` file. + +- For additional information on PowerSync's Sync Rules, refer to the [Sync Rules](/usage/sync-rules) documentation. +- If you're wondering how Sync Rules relate to Supabase Postgres [RLS](https://supabase.com/docs/guides/auth/row-level-security), see [this subsection](/integration-guides/supabase-+-powersync/rls-and-sync-rules). + diff --git a/snippets/create-cloud-instance.mdx b/snippets/create-cloud-instance.mdx index af3ecae..2366ac8 100644 --- a/snippets/create-cloud-instance.mdx +++ b/snippets/create-cloud-instance.mdx @@ -1,10 +1,13 @@ -1. In the [PowerSync Dashboard](/usage/tools/powersync-dashboard) Project tree, click on "**Create new instance**": - - - - - +1. In the **Overview** workspace of the [PowerSync Dashboard](/usage/tools/powersync-dashboard) you will be prompted to create your first instance: + + + + + If you previously created an instance, you can create a secondary instance by navigating to the **Manage instances** workspace and clicking on **Create new instance**. + + 2. Give your instance a name, such as "Testing". -3. Under the "**General**" tab, you can change the default cloud region from US to EU, JP (Japan), AU (Australia) or BR (Brazil) if desired. +3. [Optional] You can change the default cloud region from US to EU, JP (Japan), AU (Australia) or BR (Brazil) if desired. * Note: Additional cloud regions will be considered on request, especially for customers on our Enterprise plan. Please [contact us](/resources/contact-us) if you need a different region. -4. Under the **"DB Connections"** tab, click on the **+** icon and select your database technology. \ No newline at end of file +4. [Optional] You can opt in to using the Beta version of the Service, which may contain early access or experimental features. Always use the Stable version in production. +5. Click **Next**. \ No newline at end of file diff --git a/snippets/supabase-database-connection.mdx b/snippets/supabase-database-connection.mdx index f1cbf2e..879ce24 100644 --- a/snippets/supabase-database-connection.mdx +++ b/snippets/supabase-database-connection.mdx @@ -19,20 +19,19 @@ Your connection settings should look similar to this: - + 2. Verify your setup by clicking **Test Connection** and resolve any errors. -3. Configure authentication: - * Navigate to the **Client Auth** tab - * Enable **Use Supabase Auth** - * Enter your Supabase **JWT Secret** +3. Click **Next**. +4. PowerSync will detect the Supabase connection and prompt you to enable Supabase auth. To enable it, copy your JWT Secret from the Supabase Dashboard's API settings and paste it into the form: + +5. Click **Enable Supabase auth** to finalize your connections settings. - - - - -4. Click **Save and deploy** to apply your changes. + +You can update your instance settings by navigating to the **Manage instances** workspace, opening your instance options and selecting **Edit instance**. + + PowerSync will now create an isolated cloud environment for your instance. This process typically takes a few minutes.