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

Documentation update: add more information to VTX documentation #517

Open
cognitivegears opened this issue Oct 11, 2023 · 0 comments
Open
Labels
enhancement good first issue Fairly easy to pick up and go!

Comments

@cognitivegears
Copy link
Collaborator

Add additional information to the VTX documentation regarding the need for a secure (wss) connection to the webserver, and configuration that is needed in a webserver in order to pass the websocket to Enigma. See below for information from @NuSkooler about the setup:

[J]ust so you are aware, browsers won't let you connect insecurely, so you'll have to TLS aka wss://.

For my setup, it looks something like this:
Web wss:// -> [Firewall/NAT] -> nginx (TLS termination) -> enigma WebSocket (ws://). In this case, nginx maintains the trusted SSL/TLS certificate. I use Let's Encrypt for this personally.

With nginx in the mix, you need to allow it to do a WebSocket upgrade over the port (see nginx docs)

The alternative is direct:
Web wss:// -> [Firewall/NAT] -> enigma WebSocket wss://. In this case, you need to supply enigma with a trusted SSL/TSL certificate.

For the Nginx configuration, see:
https://nginx.org/en/docs/http/websocket.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement good first issue Fairly easy to pick up and go!
Projects
None yet
Development

No branches or pull requests

1 participant