Various improvements to the README.md
5,1 KiB
Vaultwarden
Alternative implementation of the Bitwarden server API written in Rust and compatible with upstream Bitwarden clients.
Vaultwarden is the perfect self-hosted solution when running the official service is too resource-heavy.
Note
This project was known as Bitwarden_RS and has been renamed to separate itself from the official Bitwarden server in the hopes of avoiding confusion and trademark/branding issues. Please see #1642 for more explanation.
This project is not associated with the Bitwarden project nor Bitwarden, Inc.
Tip
Please report any bugs or suggestions to us directly, regardless of whatever clients you are using (mobile, desktop, browser...).
Do not use the official support channels.
Features
A full implementation of the Bitwarden API:
- Organizations
- Attachments and send
- Vault API
- Serving static files
- Website icons
- Authenticator and U2F
- YubiKey and Duo
- Emergency Access
Installation
Pull the docker image and mount a volume from the host for persistent storage:
docker pull vaultwarden/server:latest
docker run -d --name vaultwarden -v /vw-data/:/data/ --restart unless-stopped -p 80:80 vaultwarden/server:latest
This will preserve any persistent data under /vw-data/
. You can adapt the path to whatever suits you.
Important
Most modern web browsers disallow the use of Web Crypto APIs in insecure contexts. In this case, you might get an error like
Cannot read property 'importKey'
. To solve this problem, you need to access the web vault via HTTPS or localhost.
This can be configured in vaultwarden directly or using a third-party reverse proxy.
If you have an available domain name, you can get HTTPS certificates with Let's Encrypt, or you can generate self-signed certificates with utilities like mkcert. Some proxies automatically do this step, like Caddy.
Usage
See the vaultwarden wiki.
Get in touch ☕
Discussions
To ask a question, offer suggestions or new features or to get help configuring or installing the software, please use GitHub Discussions or the forum.
Issues
If you spot any bugs or crashes with vaultwarden itself, please create an issue. Make sure you are on the latest version and there aren't any similar issues open, though!
Chat
If you prefer to chat, we're usually hanging around at #vaultwarden:matrix.org room on Matrix. Feel free to join us!
Sponsors
Thanks for your contribution to the project!
Chris Alfano |
Numberly |
IQ333777 |