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.

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

Jump to bottom

Document LiteFS WebSockets limitation #1342

Merged
merged 1 commit into from
Feb 12, 2024
Merged

Document LiteFS WebSockets limitation #1342

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions litefs/proxy.html.markerb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<div class="callout">
You can only use the built-in HTTP proxy described here for running LiteFS on Fly.io. If you're running LiteFS
outside of Fly.io, you will need to use an alternative method for
[configuring writes to the primary node](/docs/litefs/getting-started-docker/#configuring-writes-to-primary-node)!

Check failure on line 14 in litefs/proxy.html.markerb

View workflow job for this annotation

GitHub Actions / vale

[vale] litefs/proxy.html.markerb#L14 

[Vale.Terms] Use 'LiteFS' instead of 'litefs'.
Raw output 
{"message": "[Vale.Terms] Use 'LiteFS' instead of 'litefs'.", "location": {"path": "litefs/proxy.html.markerb", "range": {"start": {"line": 14, "column": 48}}}, "severity": "ERROR"}
</div>

LiteFS uses a single primary node for writing data and that primary node
Expand Down Expand Up @@ -81,3 +81,9 @@
protocol = "tcp"
```


## Websockets

At this time, the proxy does not work with WebSockets. You can still use LiteFS
with WebSocket applications but you will need to internally proxy the write
requests to the [current primary in the cluster](primary).
Loading