Skip to content
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.

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

docs: initial cloud usage guide page. #2257

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Conversation

thruflo
Copy link
Contributor

@thruflo thruflo commented Jan 27, 2025

Copy link

netlify bot commented Jan 27, 2025

Deploy Preview for electric-next ready!

Name Link
🔨 Latest commit c04a663
🔍 Latest deploy log https://app.netlify.com/sites/electric-next/deploys/679a3ed4a0d0990008915a83
😎 Deploy Preview https://deploy-preview-2257--electric-next.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

website/product/cloud/usage.md Outdated Show resolved Hide resolved
website/product/cloud/usage.md Outdated Show resolved Hide resolved
@thruflo
Copy link
Contributor Author

thruflo commented Jan 28, 2025

Does this look mergeable as a starting point, pending further ideas as per https://github.com/electric-sql/stratovolt/issues/240 ?

@thruflo thruflo requested a review from KyleAMathews January 28, 2025 12:49

### Proxy auth

The recommended pattern for secure use of the Electric Cloud is to add the source ID and secret parameter to the origin request made by your [auth proxy](/docs/guides/auth).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The recommended pattern for secure use of the Electric Cloud is to add the source ID and secret parameter to the origin request made by your [auth proxy](/docs/guides/auth).
The recommended pattern for secure use of the Electric Cloud is to add the source ID and secret parameter to the origin request made by your [auth proxy](/docs/guides/auth). This is generally a REST API.

import { ShapeStream } from '@electric-sql/client'

const stream = new ShapeStream({
url: `https://api.electric-sql.cloud/v1/shape`,
Copy link
Contributor

Choose a reason for hiding this comment

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

This would be their API URL

@thruflo thruflo requested a review from KyleAMathews January 29, 2025 14:44
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.

2 participants