Skip to content

Commit 8817ccc

Browse files
authored
Merge pull request #265 from powersync-ja/diagnostics-app-readme
Distinguish running the app vs signing in
2 parents d8647a4 + d4c817d commit 8817ccc

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

tools/diagnostics-app/README.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The app is currently available at [https://diagnostics-app.powersync.com/](https
1111

1212
It can also be run as a local standalone web app, and is largely based on the [web SDK](/packages/web/).
1313

14-
## Running the app
14+
## Running the app locally
1515

1616
In the root of the repository, run:
1717

@@ -28,11 +28,15 @@ pnpm dev
2828

2929
The app is now available on [http://localhost:5173/](http://localhost:5173/).
3030

31-
Generate a [development token](https://docs.powersync.com/usage/installation/authentication-setup/development-tokens) and sign in. For development tokens, the PowerSync endpoint should be populated automatically. For some others like Supabase tokens, it needs to be entered manually.
31+
## Sign in
3232

33-
If you run powersync inside docker (such as via the [self-host-demo](https://github.com/powersync-ja/self-host-demo)) the returned powersync_url is internal to the docker network and will be unreachable outside of it. Since we run the diagnostics app outside of docker, you can then connect to the endpoint as exposed by docker-proxy, e.g. `http://localhost:8080`.
33+
Signing in as a user requires a PowerSync Token (JWT) and Endpoint.
3434

35-
**Note**: Please see the known usability issues listed below.
35+
**PowerSync Token**:
36+
37+
Generate a [development token](https://docs.powersync.com/usage/installation/authentication-setup/development-tokens) for the user.
38+
39+
**PowerSync Endpoint**: For PowerSync development tokens, the endpoint should be populated automatically. For other JWTs, e.g. Supabase tokens, it needs to be entered manually. For PowerSync Cloud, this is your instance URL. For self-hosted setups (running the PowerSync service inside Docker) the returned instance URL is internal to the Docker network and will be unreachable outside of it. Since we run the diagnostics app outside of docker, you can then connect to the endpoint as exposed by docker-proxy, e.g. `http://localhost:8080`.
3640

3741
## Functionality
3842

0 commit comments

Comments
 (0)