Skip to content

Commit f700c6b

Browse files
committed
docs: add enable/disable OffSync video to offsync page
1 parent 2791961 commit f700c6b

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

sqlite-cloud/platform/offsync.mdx

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ status: publish
66
slug: offsync
77
---
88

9+
import VideoPlayer from '@commons-components/Video/VideoPlayer.astro';
10+
import enableDisableSync from '@docs-website-assets/introduction/video/offsync/dashboard_offsync_enable_disable.mp4';
11+
912
import Callout from "@commons-components/Information/Callout.astro";
1013

1114
OffSync is a powerful SQLite Cloud feature that enables true **local-first** data synchronization for your applications. Powered by the <a href="https://github.com/sqliteai/sqlite-sync" target="_blank">SQLite Sync</a> extension, it allows you to build robust, offline-capable applications where data is stored and processed on edge devices and seamlessly synchronized with a central SQLite Cloud database.
@@ -39,11 +42,16 @@ When OffSync is not yet active for a database, the panel shows a brief explanati
3942

4043
To disable OffSync, click the **Disable OffSync** button in the top-right corner of the panel and confirm the action in the dialog that appears.
4144

45+
<VideoPlayer src={enableDisableSync} />
46+
4247
### Enable Tables for Synchronization
4348

4449
From the **Sync Tables** tab, select which tables in your database you want to keep synchronized.
4550
Once enabled, all changes to those tables will automatically sync with connected devices.
4651

52+
{/* VIDEO: dashboard_offsync_sync_tables.mp4
53+
Show: Sync Tables tab open → toggle one or more tables on → confirmation that sync is active for those tables. */}
54+
4755
### Configuration Tab
4856

4957
The **Configuration** tab contains two sub-sections:
@@ -56,11 +64,17 @@ SELECT cloudsync_network_init('<database-id>');
5664

5765
**Push Notifications** — Configure an Expo access token to enable push notifications when using `sqlite-sync-react-native` in push mode. The tab shows the current notification status: **Working**, **Paused**, or **Not working**.
5866

67+
{/* VIDEO: dashboard_offsync_configuration.mp4
68+
Show: Configuration tab open → Database ID field with copy button clicked → scroll down to Push Notifications section → paste an Expo token → save → status changes to "Working". */}
69+
5970
### Manage Connected Devices
6071

6172
In the **Devices** tab, you can view all devices currently connected to your database.
6273
Here you can check their sync status and remove devices if needed.
6374

75+
{/* VIDEO: dashboard_offsync_devices.mp4
76+
Show: Devices tab open with a list of connected devices → inspect sync status of one device → remove a device from the list. */}
77+
6478
<Callout type="note" title="Matching Schemas and Tables">
6579
For OffSync to work correctly, the list of tables configured for synchronization—and their corresponding schemas—must be identical in both your local SQLite database and your SQLite Cloud database.
6680
</Callout>
@@ -73,4 +87,7 @@ The **Metrics** tab provides visibility into daily and cumulative usage for your
7387
- **Upload bytes** — data sent from devices to SQLite Cloud
7488
- **Download bytes** — data sent from SQLite Cloud to devices
7589

90+
{/* VIDEO: dashboard_offsync_metrics.mp4
91+
Show: Metrics tab open → scroll through active devices chart → upload bytes chart → download bytes chart, ideally with some non-zero data visible. */}
92+
7693
Once enabled, any changes made to the selected tables via the SQLite Sync extension will be automatically synchronized with your SQLite Cloud database.

0 commit comments

Comments
 (0)