Skip to content

Commit 7df1c98

Browse files
committed
Small edits
1 parent 5f7027a commit 7df1c98

File tree

8 files changed

+26
-20
lines changed

8 files changed

+26
-20
lines changed

architecture/architecture-overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The [PowerSync Service](/architecture/powersync-service) and client SDK operate
1616

1717
### Protocol
1818

19-
Learn about the sync protocol used between PowerSync clients and a [PowerSync service](/architecture/powersync-service):
19+
Learn about the sync protocol used between PowerSync clients and a [PowerSync Service](/architecture/powersync-service):
2020

2121
<CardGroup>
2222
<Card title="PowerSync Protocol" icon="network-wired" href="/architecture/powersync-protocol" horizontal/>

installation/database-setup/private-endpoints.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: "Private Endpoints"
44

55
## PowerSync Cloud: AWS Private Endpoints
66

7-
To avoid exposing a database in AWS to the public internet, AWS Private Endpoints (AWS PrivateLink) is an option that provides private networking between the source database and the PowerSync service. Private Endpoints are currently available on our Team and Enterprise plans.
7+
To avoid exposing a database in AWS to the public internet, AWS Private Endpoints ([AWS PrivateLink](https://aws.amazon.com/privatelink/)) is an option that provides private networking between the source database and the PowerSync Service. Private Endpoints are currently available on our [Team and Enterprise plans](https://www.powersync.com/pricing).
88

99

1010
<Warning>
@@ -14,8 +14,8 @@ Do not rely on Private Endpoints as the only form of security. Always use strong
1414
## Current Limitations
1515

1616
1. Private Endpoints are only supported for Postgres instances currently. [Contact us](/resources/contact-us) if you need this for MongoDB or MySQL.
17-
2. The guide below does not handle dynamic IPs if the RDS instance's IP changes. This needs additional work to automatically update the IP - see this [AWS Blog Post](https://aws.amazon.com/blogs/database/access-amazon-rds-across-vpcs-using-aws-privatelink-and-network-load-balancer/) on the topic. This is specifically relevant if using a RDS cluster with failover support.
18-
3. Self-service is not yet available on the PowerSync side - contact support to configure the instance.
17+
2. The guide below does not handle dynamic IPs if the RDS instance's IP changes. This needs additional work to automatically update the IP - see this [AWS blog post](https://aws.amazon.com/blogs/database/access-amazon-rds-across-vpcs-using-aws-privatelink-and-network-load-balancer/) on the topic. This is specifically relevant if using a RDS cluster with failover support.
18+
3. Self-service is not yet available on the PowerSync side - contact PowerSync support to configure the instance.
1919
4. Only AWS is supported currently, other cloud providers are not supported yet.
2020

2121
## Endpoint Service Setup
@@ -24,7 +24,7 @@ To configure a Private Endpoint Service, a network load balancer is required to
2424
1. Create a Target Group for the Network Load Balancer:
2525
1. Obtain the RDS Instance's private IP address. Make sure this points to a writable instance.
2626
2. Create a Target Group with IP addresses as target type, using the IP address from above. Use TCP protocol, and specify the database port (typically 5432 for Postgres).
27-
3. Note: The IP address of your RDS instance may change over time. To maintain a consistent connection, consider implementing automation to monitor and update the target group's IP address as needed. See the [AWS Blog Post](https://aws.amazon.com/blogs/database/access-amazon-rds-across-vpcs-using-aws-privatelink-and-network-load-balancer/) on the topic.
27+
3. Note: The IP address of your RDS instance may change over time. To maintain a consistent connection, consider implementing automation to monitor and update the target group's IP address as needed. See the [AWS blog post](https://aws.amazon.com/blogs/database/access-amazon-rds-across-vpcs-using-aws-privatelink-and-network-load-balancer/) on the topic.
2828
2. Create a Network Load Balancer (NLB):
2929
1. Select the same VPC as your RDS instance.
3030
2. Choose at least two subnets in different availability zones.
@@ -33,7 +33,7 @@ To configure a Private Endpoint Service, a network load balancer is required to
3333
3. Modify the security group associated with your RDS instance to permit traffic from the load balancer.
3434
4. Create a VPC Endpoint Service:
3535
1. In the AWS Management Console, navigate to the VPC service and select Endpoint Services.
36-
2. Click on Create Endpoint Service.
36+
2. Click on "Create Endpoint Service".
3737
3. Select the Network Load Balancer created in the previous step.
3838
4. If the load balancer is in one of the PowerSync regions (see below), it is not required to select any "Supported Region". If the load balancer is in a different region, select the region corresponding to your PowerSync instance here. Note that this will incur additional AWS charges.
3939
5. Decide whether to require acceptance for endpoint connections. Disabling acceptance can simplify the process but may reduce control over connections.
@@ -45,14 +45,14 @@ To configure a Private Endpoint Service, a network load balancer is required to
4545

4646
On PowerSync, create a new instance, but do not configure the connection yet.
4747

48-
[Contact us](/resources/contact-us) and provide the Service Name from above, as well as the PowerSync instance id created above. We will then configure the instance to use the Endpoint Service for the database connection.
48+
[Contact us](/resources/contact-us) and provide the Service Name from above, as well as the PowerSync instance ID created above. We will then configure the instance to use the Endpoint Service for the database connection.
4949

5050
## AWS Regions
5151

5252
PowerSync currently runs in the AWS regions below. Make sure the region matching your PowerSync instance is supported in by the Endpoint Service.
5353

54-
1. US: us-east-1
55-
2. EU: eu-west-1
56-
3. BR: sa-east-1
57-
4. JP: ap-northeast-1
58-
5. AU: ap-southeast-2
54+
1. US: `us-east-1`
55+
2. EU: `eu-west-1`
56+
3. BR: `sa-east-1`
57+
4. JP: `ap-northeast-1`
58+
5. AU: `ap-southeast-2`

integration-guides/coolify.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ The following Compose file serves as a universal starting point for deploying th
200200
- -c
201201
- 'mongosh --host mongo:27017 --eval ''try{rs.status().ok && quit(0)} catch {} rs.initiate({_id: "rs0", version: 1, members: [{ _id: 0, host : "mongo:27017" }]})'''
202202

203-
# PowerSync service
203+
# PowerSync Service
204204
powersync:
205205
image: journeyapps/powersync-service:latest
206206
container_name: powersync
@@ -337,7 +337,7 @@ The following Compose file serves as a universal starting point for deploying th
337337
338338
<AccordionGroup>
339339
340-
<Accordion title="Step 1: Add PowerSync service to project resources" defaultOpen={false}>
340+
<Accordion title="Step 1: Add PowerSync Service to project resources" defaultOpen={false}>
341341
Add the PowerSync Service resource to your project by either scrolling through the `Services` section or by searching for `powersync` in the search bar.
342342
<Frame>
343343
<img src="/images/coolify/powersync_resource.png"/>

resources/faq.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ mode: wide
3838
</Accordion>
3939

4040
<Accordion title="I don’t have direct database access, and can only access data via an API. Can I use PowerSync for this?">
41-
**Right now, we don’t have support for replicating data via APIs.** A workaround would be to have custom code to replicate the data from the API to a PostgreSQL instance, then sync that with PowerSync.We may add a way in the future to replicate the data directly from an API to the PowerSync service, without a database in between.
41+
**Right now, we don’t have support for replicating data via APIs.** A workaround would be to have custom code to replicate the data from the API to a PostgreSQL instance, then sync that with PowerSync. We may add a way in the future to replicate the data directly from an API to the PowerSync Service, without a database in between.
4242
</Accordion>
4343

4444
<Accordion title="Are “live queries” supported?">

resources/security.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ At PowerSync, we take security very seriously and everything we do is designed t
1212
* Additionally, customers on our [Enterprise plan](https://www.powersync.com/pricing) can request their data to be housed in managed, isolated tenants.
1313
* SOC 2 Type 2 audit results are available to customers on our [Enterprise plan](https://www.powersync.com/pricing). On our most recent annual SOC 2 audit, we had zero exceptions.
1414

15+
16+
### PowerSync Cloud: AWS Private Endpoints
17+
18+
See [Private Endpoints](/installation/database-setup/private-endpoints) for using a private network to your database using AWS PrivateLink.
19+
20+
1521
### Client-Side Security
1622

1723
Refer to: [Data Encryption](/usage/use-case-examples/data-encryption)

resources/usage-and-billing/pricing-example.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ For 50,000 app installs (5,000 Daily Active Users): **$56/month** on the Pro pla
5353
## Data Processing
5454
| | |
5555
|---------------|------|
56-
|Data replicated from Postgres to PowerSync service / month|100 messages / day \* 5,000 DAUs \* 0.25 KB \* 30 = 3.75 GB / month|
57-
|Data replicated from PowerSync service to app / month| 100 messages / day \* 5,000 DAUs \* 0.25 KB \* 30 = 3.75 GB / month|
56+
|Data replicated from Postgres to PowerSync Service / month|100 messages / day \* 5,000 DAUs \* 0.25 KB \* 30 = 3.75 GB / month|
57+
|Data replicated from PowerSync Service to app / month| 100 messages / day \* 5,000 DAUs \* 0.25 KB \* 30 = 3.75 GB / month|
5858

5959
| Total data processing costs / month | |
6060
| --- | --- |
@@ -75,7 +75,7 @@ For 50,000 app installs (5,000 Daily Active Users): **$56/month** on the Pro pla
7575
| Cost for additional usage: | 5,000,000 \* $1/1,000,000 |
7676
| **Total usage costs** | **$5 / month** |
7777

78-
## Replicated data cached on PowerSync service
78+
## Replicated data cached on PowerSync Service
7979
| | |
8080
| --- | --- |
8181
|Total size of replicated data to be cached and synced|100 messages / day \* 5,000 DAUs \* 0.25 KB \* 90 days = 11.25 GB|

self-hosting/local-development.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ For some additional details on this file, see [PowerSync Service Setup](/self-ho
135135
136136
Next, the `client_auth` sections needs to be completed.
137137

138-
The PowerSync service can verify JWTs from client applications using either HMAC (HS\*) or RSA (RS\*) based algorithms. It can also obtain the necessary settings from Supabase automatically if you are using it.
138+
The PowerSync Service can verify JWTs from client applications using either HMAC (HS\*) or RSA (RS\*) based algorithms. It can also obtain the necessary settings from Supabase automatically if you are using it.
139139

140140
1. In the case of Supabase, simply set the `supabase` key to `true`
141141
2. In the case of HS\* algorithms, specify the secret as base64 encoded in the `k`field.

usage/tools/monitoring-and-alerting.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ You can monitor activity and alert on issues and usage for your PowerSync Cloud
77

88
* **Monitor Usage**: View time-series and aggregated usage data with [Usage Metrics](#usage-metrics)
99

10-
* **Monitor Service and Replication Activity**: Track your PowerSync service and replication logs with [Instance Logs](#instance-logs)
10+
* **Monitor Service and Replication Activity**: Track your PowerSync Service and replication logs with [Instance Logs](#instance-logs)
1111

1212
* **Configure Alerts**: Set up alerts for replication issues or usage activity \*
1313

0 commit comments

Comments
 (0)