- Nov 12, 2020
- Reaction score
What is Nitro Websockets?NitroWebsockets is a plugin that adds Nitro HTML5 Client compatibility to any hotel running Arcturus MS 3.0.0 and above.
How do I configure the plugin?Startup the plugin so it generates the required entries under your emulator_settings table. The following fields will be generated:
- websockets.whitelist - a comma-delimited list containing all permitted Origin headers. You should write the domain name of your hotel here since the WebSocket connection will be initiated there. Wildcards are also supported, so you can whitelist all subdomains by adding for example: *.example.com, or even whitelist all origins by adding * (not recommended)
- ws.nitro.host - host IP, should leave it as 0.0.0.0
- ws.nitro.port - host port, can be any port but if you want to proxy WSS traffic with Cloudflare read the following section
- ws.nitro.ip.header - header that will be used for obtaining the user's real IP address if the server is behind a proxy. Will most likely be needed to be set to X-Forwarded-For or CF-Connecting-IP if behind Cloudflare.
How do I connect to my emulator using Secure Websockets (WSS)?You have several options to add WSS support to your WebSocket server.
- You can add your certificate and key file to the path /ssl/cert.pem and /ssl/privkey.pem to add WSS support directly to the server Note: The client will not accept self-signed certificates, you must use a certificate signed by a CA (you can get one for free from letsencrypt.org)
- or you can proxy WSS with either Cloudflare or Nginx. Note: Adding a proxy means that you will have to configure ws.nitro.ip.header so that the plugin is able to get the player's real IP address, and not the IP address of the proxy.
Proxying WSS with CloudflareYou can easily proxy WSS traffic using Cloudflare. However, you should first make sure that your ws.nitro.port is set to one that is listed as HTTPS Cloudflare Compatible in the following link:
As of writing this, the following ports are listed as compatible:
Finally, create a new page rule under the Page Rules tab in Cloudflare and disable SSL for the subdomain you created above. You will now be able to connect using secure WebSockets using the following example URL, where I created an A record for the subdomain WS and I set my ws.nitro.port to 2096: wss://ws.example.com:2096
FAQSI am getting the error Unable to load ssl: File does not contain valid private key: ssl\privkey.pem
Make sure your private key is in PKCS#8 format. You can convert it to PKCS8 format with the following command:
openssl pkcs8 -topk8 -nocrypt -in yourkey.pem -out yournewkey.pem
I am getting disconnected from the client with no error logs
Make sure your SSO ticket is valid and that you didn't do an IP ban before configuring the ws.nitro.ip.header if you're behind a proxy.