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

Document websocket support #3073

Open
sjberman opened this issue Jan 29, 2025 · 3 comments
Open

Document websocket support #3073

sjberman opened this issue Jan 29, 2025 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@sjberman
Copy link
Collaborator

As an NGF user
I want to know how to use NGF works with websocket applications
So that I can run my websocket application fronted by NGF.

Acceptance

  • Write a brief document or paragraph on how to use websocket services with NGF
    • This really just involves the client setting the Upgrade: websocket header in a request.
    • Any additional websocket-specific headers can be specified in a header filter if necessary (like Sec-WebSocket-Key or Sec-WebSocket-Version
@sjberman sjberman added the documentation Improvements or additions to documentation label Jan 29, 2025
@idc77
Copy link

idc77 commented Feb 2, 2025

An example default route
this is of type Exact

    location = /query {
        

        

        proxy_http_version 1.1;
        proxy_set_header Host "$gw_api_compliant_host";
        proxy_set_header X-Forwarded-For "$proxy_add_x_forwarded_for";
        proxy_set_header Upgrade "$http_upgrade";
        proxy_set_header Connection "$connection_upgrade";
        proxy_set_header X-Real-IP "$remote_addr";
        proxy_set_header X-Forwarded-Proto "$scheme";
        proxy_set_header X-Forwarded-Host "$host";
        proxy_set_header X-Forwarded-Port "$server_port";
        proxy_pass http://blogs_blogs-be_80$request_uri;
            
            
            
    }

So websocket support is there by default

@sjberman
Copy link
Collaborator Author

sjberman commented Feb 3, 2025

Yes, websockets are supported. We just want to make sure we document it so users are aware.

Copy link
Contributor

This issue is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 14 days.

@github-actions github-actions bot added the stale Pull requests/issues with no activity label Feb 18, 2025
@sjberman sjberman removed the stale Pull requests/issues with no activity label Feb 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: 🆕 New
Development

No branches or pull requests

2 participants