aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMiroslav Prasil <[email protected]>2018-10-14 23:25:16 +0100
committerMiroslav Prasil <[email protected]>2018-10-14 23:25:16 +0100
commit9ecc98c3ccdb01c6c69765f543100256be5a12c1 (patch)
tree463b5181c9d31fdd22d314058692974ac76735e6 /README.md
parent02fd68d63b0d1d82665b187098feb6d25caeb471 (diff)
downloadvaultwarden-9ecc98c3ccdb01c6c69765f543100256be5a12c1.tar.gz
vaultwarden-9ecc98c3ccdb01c6c69765f543100256be5a12c1.zip
Disable WebSockets negotiation by default
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index 353e0536..b81b954d 100644
--- a/README.md
+++ b/README.md
@@ -212,12 +212,23 @@ docker run -d --name bitwarden \
*Important: This does not apply to the mobile clients, which use push notifications.*
To enable WebSockets notifications, an external reverse proxy is necessary, and it must be configured to do the following:
-- Route the `/notifications/hub` endpoint to the WebSocket server, by default at port `3012`, making sure to pass the `Connection` and `Upgrade` headers.
+- Route the `/notifications/hub` endpoint to the WebSocket server, by default at port `3012`, making sure to pass the `Connection` and `Upgrade` headers. (Note the port can be changed with `WEBSOCKET_PORT` variable)
- Route everything else, including `/notifications/hub/negotiate`, to the standard Rocket server, by default at port `80`.
- If using Docker, you may need to map both ports with the `-p` flag
Example configurations are included in the [PROXY.md](https://github.com/dani-garcia/bitwarden_rs/blob/master/PROXY.md) file.
+Then you need to enable WebSockets negotiation on the bitwarden_rs side by setting the `WEBSOCKET_ENABLED` variable to `true`:
+
+```sh
+docker run -d --name bitwarden \
+ -e WEBSOCKET_ENABLED=true \
+ -v /bw-data/:/data/ \
+ -p 80:80 \
+ -p 3012:3012 \
+ mprasil/bitwarden:latest
+```
+
Note: The reason for this workaround is the lack of support for WebSockets from Rocket (though [it's a planned feature](https://github.com/SergioBenitez/Rocket/issues/90)), which forces us to launch a secondary server on a separate port.
### Enabling U2F authentication