apunkt/SurfSense
1
0
Fork 0
mirror of https://github.com/MODSetter/SurfSense.git synced 2026-04-25 00:36:31 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs: add database permission requirements for Zero in managed environments

Browse source 
Document that the Postgres user needs REPLICATION and CREATE privileges
for zero-cache. Docker setup handles this automatically (superuser), but
managed databases (RDS, Supabase, etc.) may need explicit grants.
This commit is contained in:
CREDO23 2026-03-23 20:01:06 +02:00
parent cf21eaacfc
commit 7d7d032e78
1 changed files with 18 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

18
surfsense_web/content/docs/how-to/zero-sync.mdx
View file

@ -48,6 +48,24 @@ If running the frontend outside Docker (e.g., `pnpm dev`), you need:
When deploying behind a reverse proxy, set `NEXT_PUBLIC_ZERO_CACHE_URL` to your public zero-cache URL (e.g., `https://zero.yourdomain.com`). The zero-cache service must be accessible via WebSocket from the browser.
### Database Requirements
zero-cache connects to PostgreSQL using logical replication. The database must meet these requirements:
1. **`wal_level = logical`** — already configured in the bundled `postgresql.conf`
2. **The database user must have `REPLICATION` privilege** — required for creating logical replication slots
In the default Docker setup, the `surfsense` user is a PostgreSQL superuser and has all required privileges automatically.
**For managed databases** (RDS, Supabase, Cloud SQL, etc.) where the app user may not be a superuser, you need to grant replication privileges:
```sql
ALTER USER surfsense WITH REPLICATION;
GRANT CREATE ON DATABASE surfsense TO surfsense;
```
The `REPLICATION` privilege allows zero-cache to create a logical replication slot for streaming changes. The `CREATE` privilege allows zero-cache to create internal schemas (`zero`, `zero_0`) for its metadata.
## Synced Tables
Zero syncs the following tables for real-time features: