Introduction to and overview of the PowerSync Dashboard
The PowerSync Dashboard is available in PowerSync Cloud (our cloud-hosted offering) and provides an interface for managing your PowerSync organization, projects, instances, and account settings.The dashboard is available here: https://dashboard.powersync.com/
To get started, you’ll need to create a project in your organization.
When you click “Create a New Project”, you can opt to create a Development and Productioninstance automatically for that project (recommended). An instance runs a copy of the PowerSync Service and connects to your backend source database. You can also update region for each instance from US to EU, JP (Japan), AU (Australia) or BR (Brazil).
Here is an example of how this hierarchy might be used by a customer:
URL structure: https://dashboard.powersync.com/org/{orgId}/projectsAt the organization level, you can manage your PowerSync projects and organization-wide settings. Navigate to your organization to access:
Projects - View all projects in your organization, create new projects, and manage project settings
Team - Invite team members to your organization, manage user roles, and remove access
Plans & Billing - View or update your PowerSync subscription plan and manage billing details
Plan Usage - Monitor usage metrics across all projects in your organization for the current billing cycle
URL structure: https://dashboard.powersync.com/org/{orgId}/project/{projectId}/{instanceId}/{view}When you navigate to a specific instance, you’ll see a left sidebar with various views for configuring and monitoring that instance:
Health - Overview of its connection health, deploy history, replication status, and recently connected clients
Database Connections - Configure and manage the source database connection
Client Auth - Configure authentication settings
Sync Rules - Edit, validate, and deploy your Sync Rules
Here are some of the most common tasks you’ll perform in the dashboard:
Edit and deploy Sync Rules - Select your project and instance and go to the Sync Rules view to edit your Sync Rules, then click “Validate” and “Deploy” to deploy them
Generate development token - Navigate to the Client Auth and ensure the Development tokens setting is checked. Click the “Connect” button in the top bar and follow instructions to generate a development token.
Launch the Sync Diagnostics Client - Navigate to the Sync Test, generate a development token and click “Launch” to launch the Sync Diagnostics Client.
Copy your instance URL - Click Connect in the top bar and copy the instance URL from the dialog.
Generate client-side schema - Click the Connect button in the top bar to generate the client-side schema based on your Sync Rules in your preferred language
Monitor instance health - Navigate to the Health view to see an overview of your instance status, database connections, and recent deploys
View logs - Navigate to the Logs view to review replication and client sync logs
Monitor metrics - Navigate to the Metrics view to track usage metrics
Customers on our Team and Enterprise plans can lock their PowerSync Cloud instances to a specific version of the PowerSync Service. This option is available under your instance settings.Versions are specified as major.minor.patch. When locked, only new .patch releases will automatically be applied to the instance.Downgrade limitations: Not all downgrade paths are available automatically. If you need to downgrade to an older version, please contact our team for assistance.