https

dimdenGD · Oct 4, 2024 · 618d3b5 · 618d3b5
1 parent ccbe9c2
commit 618d3b5
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -100,6 +100,22 @@ const wsServer = new WebSocketServer({ server: server });
 server.listen(3000);
 ```
 
+## HTTPS
+
+Ultimate WS supports HTTPS. You can pass `uwsOptions` to `WebSocketServer` to configure it:
+```js
+const { WebSocketServer } = require("ultimate-ws");
+
+const wsServer = new WebSocketServer({
+    port: 3000,
+    uwsOptions: {
+        // https://unetworking.github.io/uWebSockets.js/generated/interfaces/AppOptions.html
+        key_file_name: "path/to/key.pem",
+        cert_file_name: "path/to/cert.pem",
+    }
+});
+```
+
 ## Compatibility
 
 ✅ - Full support (all features and options are supported)