Skip to content

Document remote Supabase access via Cloudflare Tunnel #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
atharvas merged 3 commits into from
Apr 16, 2026
Merged

Document remote Supabase access via Cloudflare Tunnel #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5beb876
Add remote access section to CLAUDE.md Supabase docs
atharvas Apr 16, 2026
9600fe2
Fix db-tunnel to use explicit cloudflared config path
atharvas Apr 16, 2026
a8ed6ce
Add remote access quick-start to README
atharvas Apr 16, 2026
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
12 changes: 11 additions & 1 deletion CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,14 +112,24 @@ import time (`src/datasmith/__init__.py` → `dotenv.load_dotenv`), so reading
`DATASMITH_RL_MAX_RETRIES`, `DATASMITH_NEIGHBOR_WINDOW_DAYS`,
`DATASMITH_NEIGHBOR_CAP`.

## Supabase (local)
## Supabase

fc-data uses a **local Supabase** instance for all persistent state. Connection details live in `tokens.env`:

- `SUPABASE_URL=http://127.0.0.1:54321` (PostgREST API)
- `SUPABASE_KEY=sb_secret_...` (service-role key)
- Direct Postgres: `host=127.0.0.1 port=54322 dbname=postgres user=postgres password=postgres`

### Remote access

The Supabase PostgREST API is also available at `https://db.formulacode.org` via a Cloudflare Tunnel, protected by Cloudflare Access service tokens. To connect from a remote machine, set these in `tokens.env`:

- `SUPABASE_URL=https://db.formulacode.org`
- `DATASMITH_CF_ACCESS_CLIENT_ID` — Cloudflare Access service-token Client ID
- `DATASMITH_CF_ACCESS_CLIENT_SECRET` — Cloudflare Access service-token Client Secret

When both `DATASMITH_CF_ACCESS_*` vars are set, `get_client()` and `get_async_client()` in `utils/db.py` automatically inject the required headers. See `docs/guide/remote-access.md` for full setup instructions.

### Key tables

| Table | Purpose | Populated by |
Expand Down
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ grafana-tunnel: ## Expose Grafana publicly via Cloudflare Tunnel

.PHONY: db-tunnel
db-tunnel: ## Expose Supabase PostgREST API via Cloudflare Tunnel (db.formulacode.org)
@cloudflared tunnel run datasmith-db
@cloudflared tunnel --config ~/.cloudflared/config-db.yml run datasmith-db


.PHONY: help
Expand Down
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,16 @@ $ npx supabase stop # stop all containers

Studio is available at the URL printed by `supabase status` (default `http://127.0.0.1:54323`) — use it to browse tables, run SQL, and inspect data.

#### Remote access

To connect from a remote machine (without running Supabase locally), the PostgREST API is available at `https://db.formulacode.org` via a Cloudflare Tunnel. Add these to your `tokens.env`:
```bash
SUPABASE_URL=https://db.formulacode.org
DATASMITH_CF_ACCESS_CLIENT_ID=your-cf-client-id
DATASMITH_CF_ACCESS_CLIENT_SECRET=your-cf-client-secret
```
See the [Remote Access guide](docs/guide/remote-access.md) for full setup and credential provisioning.

Running `preflight` ensures that all the variables are properly defined:
```bash
$ python -m datasmith.preflight
Expand Down
Loading