Odoo GraphQL Subscription

Setup Instructions

Only Applicable for GraphQL Subscription.
Odoo setup instruction when configured behind the nginx proxy.

map $http_upgrade $connection_upgrade {

    default upgrade;
    ''      close;

  }

  server {

    # Your existing server configuration...

    # Set HTTP version to 1.1
    proxy_http_version 1.1;

    # Set headers for WebSocket upgrade
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";

    # Your GraphQL subscription endpoint location.
    # This is required when you use a worker (gevent) based Odoo server.
    location /graphql-subscription-endpoint {
        # Proxy pass to the Odoo server running on localhost at port 8072.
        # 8072 is gevent_port should be defined in odoo configuration file.
        proxy_pass http://127.0.0.1:8072;

        # Set headers for WebSocket upgrade
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection $connection_upgrade;

        # Set headers for forwarding request details
        proxy_set_header X-Forwarded-Host $host;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header X-Real-IP $remote_addr;

    }

    # Your other server configurations...
}

Explanation

• proxy_http_version 1.1 : Sets the HTTP version to 1.1 for proxy connections.
• proxy_set_header Upgrade $http_upgrade : Sets the Upgrade header to $http_upgrade, enabling WebSocket upgrade support.
• proxy_set_header Connection "upgrade" : Sets the Connection header to “upgrade” to signal WebSocket connection upgrade.
• location /graphql-subscription-endpoint { … } : Defines a location block for handling requests to the GraphQL subscription endpoint.
• proxy_pass http://127.0.0.1:8072 : Forwards requests to the Odoo server running on http://127.0.0.1:8072.
• proxy_set_header X-Forwarded-Host $host : Sets the X-Forwarded-Host header to the value of $host, indicating the original host requested by the client.
• proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for : Appends the client's IP address to the X-Forwarded-For header to indicate the client's original IP.
• proxy_set_header X-Forwarded-Proto $scheme : Sets the X-Forwarded-Proto header to the value of $scheme, indicating the protocol used by the client (HTTP or HTTPS).
• proxy_set_header X-Real-IP $remote_addr : Sets the X-Real-IP header to the client's IP address, providing the real IP of the client to the backend server.

We understand that even with great documentation, you might have questions or need additional assistance. That's why we offer exceptional support for "Odoo REST API Framework" users!

https://ekika.co/api

Documentation & User Guide
(copy link to clipboard)

https://www.youtube.com/@ekika_co/videos

Video Guide
(copy link to clipboard)

https://ekika.co/support

Support
(copy link to clipboard)