suddjian commented on a change in pull request #11498: URL: https://github.com/apache/superset/pull/11498#discussion_r607371714
########## File path: superset-websocket/README.md ########## @@ -0,0 +1,80 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> +# Superset WebSocket Server + +A Node.js WebSocket server for sending async event data to the Superset web application frontend, based on [SIP-39](https://github.com/apache/superset/issues/9190). + +## Requirements + +- Node.js 12+ (not tested with older versions) +- Redis 5+ + +To use this feature, Superset needs to be configured to enable global async queries and to use WebSockets as the transport (see below). + +## Install + +Install dependencies: +``` +npm install +``` + +## WebSocket Server Configuration + +Copy `config.example.json` to `config.json` and adjust the values for your environment. + +## Superset configuration + +Configure the Superset Flask app to enable global async queries (in `superset_config.py`): + +Enable the `GLOBAL_ASYNC_QUERIES` feature flag: +``` +"GLOBAL_ASYNC_QUERIES": True +``` + +Configure the following Superset values: +``` +GLOBAL_ASYNC_QUERIES_TRANSPORT = "ws" +GLOBAL_ASYNC_QUERIES_WEBSOCKET_URL = "ws://<host>:<port>/" +``` + +Note that the WebSocket server must be run on the same hostname (different port) for cookies to be shared between the Flask app and the WebSocket server. Review comment: Keeping the cookie httponly is a good move! -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
