Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed images/usage-1.avif
Binary file not shown.
Binary file removed images/usage-2.avif
Binary file not shown.
File renamed without changes.
Binary file added images/usage/tools/dashboard-components.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/usage/tools/dashboard-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 13 additions & 13 deletions usage/tools/powersync-dashboard.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@ title: "PowerSync Dashboard"
description: "Introduction to and overview of the PowerSync Dashboard and Admin Portal"
---

The PowerSync Dashboard is available with [PowerSync Cloud](https://www.powersync.com/pricing) (our cloud-hosted offering).

The PowerSync Dashboard provides an interface for developers to:
The PowerSync Dashboard is available in [PowerSync Cloud](https://www.powersync.com/pricing) (our cloud-hosted offering) and provides an interface for developers to:

* Manage PowerSync projects
* Manage PowerSync instances
Expand All @@ -19,11 +17,11 @@ The dashboard is available here: [https://powersync.journeyapps.com/](https://po
### Hierarchy: Organization, project, instance

* After successfully [signing up](https://accounts.journeyapps.com/portal/get-started?powersync=true) for PowerSync Cloud, your PowerSync account is created.
* Your account is assigned a new "Trial" **organization** on the [Free pricing plan](https://www.powersync.com/pricing). (Note that the use of the term "Trial" is temporary and will be removed in a future release — You have indefinite access to the PowerSync Free plan, not a time-limited trial)
* A sample PowerSync **project** (named "Trial 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:
* Your account is assigned an **organization** on the [Free pricing plan](https://www.powersync.com/pricing).
* 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:

<Frame caption="PowerSync dashboard">
<img src="/images/usage-1.avif"/>
<img src="/images/usage/tools/dashboard-overview.png"/>
</Frame>

* 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](/architecture/powersync-service) and connects to your Postgres database.
Expand All @@ -32,8 +30,8 @@ Here is an example of how this hierarchy might be used by a customer:

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

### Dashboard layout

Expand All @@ -45,17 +43,19 @@ The Dashboard layout is similar to that of an IDE and includes the following mai
* [Actions](/usage/tools/powersync-dashboard#actions)

<Frame caption="Dashboard components">
<img src="/images/usage-2.avif"/>
<img src="/images/usage/tools/dashboard-components.png"/>
</Frame>

#### 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 two workspaces by default: **Default Workspace** and **Metrics**.
The dashboard comes with four workspaces by default: **Overview**, **Manage instances**, **Usage metrics** and **Instance logs**.

* The Default Workspace is configured to manage instances, update, validate and deploy sync rules.
* The Metrics workspace displays your project's usage metrics.
* 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.

Expand Down Expand Up @@ -108,7 +108,7 @@ It is available here:
</Info>

<Frame caption="Admin Portal">
<img src="/images/usage-3.avif"/>
<img src="/images/usage/tools/admin-portal.avif"/>
</Frame>


Expand Down
Loading