Skip to content

docs(hosted-sinks): add provider walkthroughs for Supabase, Neon, and ClickHouse Cloud#807

Open
joshkauffman wants to merge 7 commits into
developfrom
docs/hosted-sinks-provider-walkthroughs
Open

docs(hosted-sinks): add provider walkthroughs for Supabase, Neon, and ClickHouse Cloud#807
joshkauffman wants to merge 7 commits into
developfrom
docs/hosted-sinks-provider-walkthroughs

Conversation

@joshkauffman

Copy link
Copy Markdown
Contributor

Summary

  • Adds step-by-step walkthrough for connecting Hosted Sinks to Supabase (managed Postgres)
  • Adds step-by-step walkthrough for connecting Hosted Sinks to Neon (serverless Postgres)
  • Adds step-by-step walkthrough for connecting Hosted Sinks to ClickHouse Cloud
  • Updates hosted-sinks.md with a Provider Walkthroughs section linking all three guides

Each walkthrough covers: getting credentials from the provider console, creating a dedicated DB user/role with scoped permissions, network access configuration, sink field values, and troubleshooting tips.

Test plan

  • Verify links in hosted-sinks.md resolve to the new files
  • Confirm ClickHouse Cloud walkthrough reflects port 9440 (TLS) and us-central1 region note
  • Confirm Neon walkthrough includes endpoint suspension caveat for free tier
  • Confirm Supabase walkthrough warns against using the pooler host

🤖 Generated with Claude Code

… ClickHouse Cloud

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@sduchesneau

sduchesneau commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

🔍 Vulnerabilities of ghcr.io/streamingfast/substreams:2a0c04d

📦 Image Reference ghcr.io/streamingfast/substreams:2a0c04d
digestsha256:66a8bd6da467b478ebc5145abd6b1fbce99e000e506f5b1aefea761f8404755c
vulnerabilitiescritical: 0 high: 0 medium: 0 low: 0
platformlinux/amd64
size111 MB
packages353
📦 Base Image ubuntu:24.04
also known as
  • c136481b8f4cd58cb213a22ee358ea1047bc963a338c61cdccb518e233409f86
  • noble
  • noble-20260509.1
digestsha256:023f8a753c22258c9fe2d0005a7d28258038da7d620e9f93e9ad78aa266f9f11
vulnerabilitiescritical: 0 high: 1 medium: 25 low: 11

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
## 1. Create a ClickHouse Cloud Service

1. Sign in to [clickhouse.cloud](https://clickhouse.cloud) and open your organization.
2. Click **New service**, choose a cloud provider and region close to StreamingFast's infrastructure, and select a service tier.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

region close to StreamingFast's infrastructure don't we want to mention it here which region is it?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

1. In your service, go to **Settings → Security → IP Access List**.
2. Click **Add entry** and add `0.0.0.0/0` to allow connections from any IP.
3. Save the access list.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everywhere we have this 0.0.0.0, add a hint to contact us if someone has increased enterprise needs where they need to restrict to a given IP range

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added here. Reviewing if found in other pages.


## 5. Configure the Hosted Sink

In [The Graph Market](https://thegraph.market/sinks), create a new sink and fill in the **Output** section:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have https://thegraph.market/sinks/new that even show up the new sink directly.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed here and in other example pages

### 3. Output

Choose **Postgres** or **ClickHouse** and fill in the connection details.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would hint here users about out procedure for some popular SQL servives

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added note

Clarified instructions for creating a ClickHouse Cloud service and added note on IP access restrictions.
Added walkthroughs for SQL services to the Hosted Sink guide.
By default, ClickHouse Cloud restricts inbound connections. You must allow StreamingFast's infrastructure to reach your service. Hosted Sinks runs in **us-central1 (Iowa)**.

1. In your service, go to **Settings → Security → IP Access List**.
2. Click **Add entry** and add `0.0.0.0/0` to allow connections from any IP. Note, if you require a restricted IP range, please contact us at support@streamingfast.io.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it could be turn into a mailto: link which usually in browser auto open email client, easy to check on GitBook preview

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants