PowerSync Dashboard

The PowerSync Dashboard is available in PowerSync Cloud (our cloud-hosted offering) and provides an interface for developers to:

• Manage PowerSync projects
• Manage PowerSync instances
• Write, validate and deploy sync rules
• Generate the client-side schema
• Generate development tokens
• Monitor usage and configure alerts - see Monitoring and Alerting

The dashboard is available here: https://powersync.journeyapps.com/

​

Hierarchy: Organization, project, instance

• After successfully signing up for PowerSync Cloud, your PowerSync account is created.
• Your account is assigned an organization on the Free pricing plan.
• A sample PowerSync project (named “PowerSync Project”) is automatically created in this organization, and this project is your starting point after completing sign-up. It is opened by default in the dashboard:

• Within a project, you can create and manage one or more PowerSync instances for your project (typically developers maintain a staging and production instance). An instance runs a copy of the PowerSync Service and connects to your Postgres database.

Here is an example of how this hierarchy might be used by a customer:

• Organization: Acme Corporation
  • Project: Travel App
    • Instance: Staging
    • Instance: Production

​

Dashboard layout

The Dashboard layout is similar to that of an IDE and includes the following main components:

• Workspaces
• Editor Panes, Panels and Files
• The Command Palette
• Actions

​

Workspaces

Workspaces are a pre-configured logical collection of editor panes and panels that are designed to make working on a specific part of your project as easy as possible.

The dashboard comes with four workspaces by default: Overview, Manage instances, Usage metrics and Instance logs.

• The Overview workspace presents an overview of your PowerSync instances, or guides you through creating your first instance.
• The Manage instances workspace is allows you to create, view and update PowerSync instances, validate and deploy sync rules, and view deploy logs by instance.
• The Usage metrics workspace displays your project’s usage metrics by instance.
• The Instance logs workspace displays replication and service logs by instance.

You can customize any of these workspaces (changes save automatically) and/or create new workspaces.

To reset all workspaces to their original layout, run the Reset workspaces action (see Command Palette and Actions below for how to run actions)

​

Editor Panes, Panels and Files

Editor Panes are used to interact with your project’s files (e.g. sync-rules.yaml) and Panels display information about your project in components that can be positioned and resized.

​

The Command Palette

Open the Command Palette using the keyboard shortcut CTRL/CMD+SHIFT+P or SHIFT+SHIFT, and access just about anything you need to do in your project.

​

Actions

The various actions available in your project are accessible via the Command Palette, by right-clicking on certain items, and via buttons. These are a few of the most common actions you might need during the lifecycle of your PowerSync project (you can search them via the Command Palette):

• Generate development token -> Generate a development token for authentication
• Generate client-side schema -> Generate the client-side schema for an instance based off your sync rules.
• Validate sync rules -> Validate the sync rules defined in your sync-rules.yaml against an instance.
• Deploy sync rules -> Deploy sync rules as defined in your sync-rules.yaml file to an instance.
• Compare deployed sync rules -> Compare the sync rules as defined in your sync-rules.yaml file with those deployed to an instance.
• Save changes -> Save changes to files as a revision when in Basic Revisions version control mode (see Version Control below)
  • Or Commit changes -> Commit changes to files when in Advanced Git version control mode.
• Create Personal Access Token -> Create an access token scoped to your user, which is needed for the CLI.
• Rename project -> Rename your PowerSync project.

​

Version Control

Your PowerSync projects come with version control built-in. This is useful when working with your project’s sync rules file (sync-rules.yaml). The default mode is Basic Revisions, which allows you to save, view and revert to revisions of your sync rules file. Another mode is Advanced Git, which enables a git-based workflow, including commits, branching, and merging. The modes can be toggled for your projects in the Admin Portal (see below).

​

Saving/committing changes

Open the Changes panel (find it via the Command Palette) to review any changes and save, or revert to a specific revision/commit.

​

GitHub / Azure Repos integration

The default git provider for projects is our own “JourneyApps” system which does not require any configuration from the developer. It is also possible to use either GitHub or Azure DevOps as your git provider. For this to work, an integration must be added to your organization via the Admin Portal. Read on to learn more.

​

Admin Portal

In the Admin Portal you can manage your PowerSync projects, users and integrations.

It is available here:

https://accounts.journeyapps.com/portal/admin/accounts.journeyapps.com

​

Manage PowerSync projects

In the “Projects” tab, new projects can be created, existing projects can be deleted, and the version control mode can be changed for a project. If your project uses the Advanced Git version control mode, the git provider can also be configured here.

​

Manage users

Select the “Developers” tab to invite team members to your organization or remove their access. Only users with the Owner role can manage users.

​

Manage integrations

In the “Integrations” tab, GitHub or Azure DevOps integrations can be added in order to configure them as git providers for your project(s).

​

Update organization settings

In the “Settings” tab, you can rename your organization.

​

Update billing details

In the “Billing” tab, you can update your billing details and manage payment cards.

View subscriptions

In the “Subscriptions” tab, you can view your active subscription and usage.

See Pricing for available subscription plans.