Skip to content

Document websocket support #3073

@sjberman

Description

@sjberman
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

Activity

idc77

idc77 commented on Feb 2, 2025

@idc77

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

sjberman commented on Feb 3, 2025

@sjberman
CollaboratorAuthor

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

github-actions

github-actions commented on Feb 18, 2025

@github-actions
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.

removed
stalePull requests/issues with no activity
on Feb 18, 2025
added this to the v2.0.0 milestone on Feb 19, 2025
modified the milestones: v2.0.0, v2.1.0 on May 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    Status

    🆕 New

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @mpstefan@sjberman@idc77

        Issue actions

          Document websocket support · Issue #3073 · nginx/nginx-gateway-fabric