Skip to content

Commit bb9a1eb

Browse files
committed
Add more clarifications.
1 parent 8a52e01 commit bb9a1eb

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

self-hosting/lifecycle-maintenance.mdx

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,9 @@ server {
8686
proxy_set_header X-Real-IP $remote_addr;
8787
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
8888

89-
# Disable proxy buffering - important for HTTP streaming connections (configured in the PowerSync client SDK)
89+
# Disable proxy response buffering.
90+
# This is not relevant for websocket connections, but is important when using
91+
# HTTP streaming connections (configured in the PowerSync client SDK).
9092
proxy_buffering off;
9193
}
9294
}
@@ -104,9 +106,11 @@ If the load balancer supports health checks, it may be configured to poll the AP
104106

105107
### Migrations
106108

109+
Occasionally, new versions of the PowerSync service image may require migrations on the underlying storage database. This is also specifically required the first time the service starts up on a new storage database.
110+
107111
By default, migrations are run as part of the replication and API containers. In some cases, a migration may add signifant delay to the container startup.
108112

109-
To avoid this, the migrations may be run as a separate job on each update, before replacing the rest of the containers. To run the migrations, run the docker command `migrate up`, for example `docker run powersync migrate up`.
113+
To avoid this startup delay, the migrations may be run as a separate job on each update, before replacing the rest of the containers. To run the migrations, run the docker command `migrate up`, for example `docker run powersync migrate up`.
110114

111115
In this case, disable automatic migrations in the config:
112116

@@ -119,6 +123,9 @@ migrations:
119123
disable_auto_migration: true
120124
```
121125
126+
Note that if you disable automatic migrations, and do not run the migration job manually,
127+
the service may run with an outdated storage schema version. This may lead to unexpected and potentially difficult-to-debug errors in the service.
128+
122129
## Backups
123130
124131
We recommend using Git to backup your configuration files.

0 commit comments

Comments
 (0)