[PR #6041] improve the usage section of the README #2485

New Issue

OVERLORD · 2025-10-09T18:06:00+03:00

OVERLORD commented

2025-10-09 18:06:00 +03:00

Original Pull Request: https://github.com/dani-garcia/vaultwarden/pull/6041

State: closed
Merged: Yes

Given a recent influx of people having issues with the infinite loading/spinning circle (cf. #5486, #5506, #5602, #5815, #5820, #5864, #5971 and also this guy) I think that it might be helpful to reword the usage section a bit because at the moment it sounds a bit like this is optional and also dependent on an error message that does not show up any more. (The web-vault used to show a toast with a warning but since a few releases it requires the secure context earlier and just throws an exception about that in the web console which many beginners won't check.)

Setting the port to publish to 127.0.0.1:8000 should also make it clearer that you need to open the Web-Vault via localhost or setup a reverse proxy that enables access via HTTPS if you want it accessible on other hosts.

My next TODO would be to streamline the Proxy examples page because at the moment they differ a lot (some using 127.0.0.1:8080, localhost:8080 some using <SERVER>:80, <SERVER>:8080 or <SERVER>:<SERVER_PORT>) and also updating the Enabling HTTPS page.

I'm not that sure about the docker compose example however if I compare it with this wiki page. (Maybe it would be better to just remove it again?)

**Original Pull Request:** https://github.com/dani-garcia/vaultwarden/pull/6041 **State:** closed **Merged:** Yes --- Given a recent influx of people having issues with the infinite loading/spinning circle (cf. #5486, #5506, #5602, #5815, #5820, #5864, #5971 and also [this guy](https://www.youtube.com/embed/u_Lxkt50xOg?start=688&end=718)) I think that it might be helpful to reword the usage section a bit because at the moment it sounds a bit like this is optional and also dependent on an error message that does not show up any more. (The web-vault used [to show a toast with a warning](https://github.com/bitwarden/clients/commit/df01025dabbb1b01a7c82bde4b303fd8932e3701) but since a few releases it requires the secure context earlier and just throws an exception about that in the web console which many beginners won't check.) Setting the port to publish to `127.0.0.1:8000` should also make it clearer that you need to open the Web-Vault via localhost or setup a reverse proxy that enables access via HTTPS if you want it accessible on other hosts. My next TODO would be to streamline the [Proxy examples](https://github.com/dani-garcia/vaultwarden/wiki/Proxy-examples) page because at the moment they differ a lot (some using `127.0.0.1:8080`, `localhost:8080` some using `<SERVER>:80`, `<SERVER>:8080` or `<SERVER>:<SERVER_PORT>`) and also updating the [Enabling HTTPS page](https://github.com/dani-garcia/vaultwarden/wiki/Enabling-HTTPS). I'm not that sure about the docker compose example however if I compare it with [this wiki page](https://github.com/dani-garcia/vaultwarden/wiki/Using-Docker-Compose). (Maybe it would be better to just remove it again?)

OVERLORD added the pull-request label 2025-10-09 18:06:00 +03:00

OVERLORD closed this issue

2025-10-09 18:06:01 +03:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/vaultwarden#2485