mirror of
https://github.com/dani-garcia/vaultwarden.git
synced 2024-12-04 22:14:51 +01:00
2f20ad86f9
Updating the Readme to be more modern and more clear. Added and moved several shields/badges and changed some default colors to have a better contrast. Added a Disclaimer section. Closes #4901 Closes #4930 Closes #4931 Closes #5024 Co-authored-by: ipitio <21136719+ipitio@users.noreply.github.com> Co-authored-by: Robert Schütz <github@dotlambda.de> Co-authored-by: Yonas Yanfa <yonas.y@gmail.com> Co-authored-by: KUSUMA RUSHIKESH <141169227+rushi-k12@users.noreply.github.com>
144 lines
11 KiB
Markdown
144 lines
11 KiB
Markdown
|
|
|
|
An alternative server implementation of the Bitwarden Client API, written in Rust and compatible with [official Bitwarden clients](https://bitwarden.com/download/) [[disclaimer](#disclaimer)], perfect for self-hosted deployment where running the official resource-heavy service might not be ideal.
|
|
|
|
---
|
|
|
|
[](https://github.com/dani-garcia/vaultwarden/releases/latest)
|
|
[](https://github.com/dani-garcia/vaultwarden/pkgs/container/vaultwarden)
|
|
[](https://hub.docker.com/r/vaultwarden/server)
|
|
[](https://quay.io/repository/vaultwarden/server) <br>
|
|
[](https://github.com/dani-garcia/vaultwarden/graphs/contributors)
|
|
[](https://github.com/dani-garcia/vaultwarden/network/members)
|
|
[](https://github.com/dani-garcia/vaultwarden/stargazers)
|
|
[](https://github.com/dani-garcia/vaultwarden/issues)
|
|
[](https://github.com/dani-garcia/vaultwarden/issues?q=is%3Aissue+is%3Aclosed)
|
|
[](https://github.com/dani-garcia/vaultwarden/blob/main/LICENSE.txt) <br>
|
|
[%3D'svg'%5D%2F*%5Blocal-name()%3D'g'%5D%5B2%5D%2F*%5Blocal-name()%3D'text'%5D%5B4%5D&style=flat-square&logo=rust&label=dependencies&color=005AA4)](https://deps.rs/repo/github/dani-garcia/vaultwarden)
|
|
[](https://github.com/dani-garcia/vaultwarden/actions/workflows/release.yml)
|
|
[](https://github.com/dani-garcia/vaultwarden/actions/workflows/build.yml) <br>
|
|
[](https://matrix.to/#/#vaultwarden:matrix.org)
|
|
[](https://github.com/dani-garcia/vaultwarden/discussions)
|
|
[](https://vaultwarden.discourse.group/)
|
|
|
|
> [!IMPORTANT]
|
|
> **When using this server, please report any bugs or suggestions directly to us (see [Get in touch](#get-in-touch)), regardless of whatever clients you are using (mobile, desktop, browser...). DO NOT use the official Bitwarden support channels.**
|
|
|
|
<br>
|
|
|
|
## Features
|
|
|
|
A nearly complete implementation of the Bitwarden Client API is provided, including:
|
|
|
|
* [Personal Vault](https://bitwarden.com/help/managing-items/)
|
|
* [Send](https://bitwarden.com/help/about-send/)
|
|
* [Attachments](https://bitwarden.com/help/attachments/)
|
|
* [Website icons](https://bitwarden.com/help/website-icons/)
|
|
* [Personal API Key](https://bitwarden.com/help/personal-api-key/)
|
|
* [Organizations](https://bitwarden.com/help/getting-started-organizations/)
|
|
- [Collections](https://bitwarden.com/help/about-collections/),
|
|
[Password Sharing](https://bitwarden.com/help/sharing/),
|
|
[Member Roles](https://bitwarden.com/help/user-types-access-control/),
|
|
[Groups](https://bitwarden.com/help/about-groups/),
|
|
[Event Logs](https://bitwarden.com/help/event-logs/),
|
|
[Admin Password Reset](https://bitwarden.com/help/admin-reset/),
|
|
[Directory Connector](https://bitwarden.com/help/directory-sync/),
|
|
[Policies](https://bitwarden.com/help/policies/)
|
|
* [Multi/Two Factor Authentication](https://bitwarden.com/help/bitwarden-field-guide-two-step-login/)
|
|
- [Authenticator](https://bitwarden.com/help/setup-two-step-login-authenticator/),
|
|
[Email](https://bitwarden.com/help/setup-two-step-login-email/),
|
|
[FIDO2 WebAuthn](https://bitwarden.com/help/setup-two-step-login-fido/),
|
|
[YubiKey](https://bitwarden.com/help/setup-two-step-login-yubikey/),
|
|
[Duo](https://bitwarden.com/help/setup-two-step-login-duo/)
|
|
* [Emergency Access](https://bitwarden.com/help/emergency-access/)
|
|
* [Vaultwarden Admin Backend](https://github.com/dani-garcia/vaultwarden/wiki/Enabling-admin-page)
|
|
* [Modified Web Vault client](https://github.com/dani-garcia/bw_web_builds) (Bundled within our containers)
|
|
|
|
<br>
|
|
|
|
## Usage
|
|
|
|
> [!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](https://github.com/dani-garcia/vaultwarden/wiki/Enabling-HTTPS) or using a third-party reverse proxy ([some examples](https://github.com/dani-garcia/vaultwarden/wiki/Proxy-examples)).
|
|
>
|
|
>If you have an available domain name, you can get HTTPS certificates with [Let's Encrypt](https://letsencrypt.org/), or you can generate self-signed certificates with utilities like [mkcert](https://github.com/FiloSottile/mkcert). Some proxies automatically do this step, like Caddy or Traefik (see examples linked above).
|
|
|
|
> [!TIP]
|
|
>**For more detailed examples on how to install, use and configure Vaultwarden you can check our [Wiki](https://github.com/dani-garcia/vaultwarden/wiki).**
|
|
|
|
The main way to use Vaultwarden is via our container images which are published to [ghcr.io](https://github.com/dani-garcia/vaultwarden/pkgs/container/vaultwarden), [docker.io](https://hub.docker.com/r/vaultwarden/server) and [quay.io](https://quay.io/repository/vaultwarden/server).
|
|
|
|
There are also [community driven packages](https://github.com/dani-garcia/vaultwarden/wiki/Third-party-packages) which can be used, but those might be lagging behind the latest version or might deviate in the way Vaultwarden is configured, as described in our [Wiki](https://github.com/dani-garcia/vaultwarden/wiki).
|
|
|
|
### Docker/Podman CLI
|
|
|
|
Pull the container image and mount a volume from the host for persistent storage.<br>
|
|
You can replace `docker` with `podman` if you prefer to use podman.
|
|
|
|
```shell
|
|
docker pull vaultwarden/server:latest
|
|
docker run --detach --name vaultwarden \
|
|
--env DOMAIN="https://vw.domain.tld" \
|
|
--volume /vw-data/:/data/ \
|
|
--restart unless-stopped \
|
|
--publish 80:80 \
|
|
vaultwarden/server:latest
|
|
```
|
|
|
|
This will preserve any persistent data under `/vw-data/`, you can adapt the path to whatever suits you.
|
|
|
|
### Docker Compose
|
|
|
|
To use Docker compose you need to create a `compose.yaml` which will hold the configuration to run the Vaultwarden container.
|
|
|
|
```yaml
|
|
services:
|
|
vaultwarden:
|
|
image: vaultwarden/server:latest
|
|
container_name: vaultwarden
|
|
restart: unless-stopped
|
|
environment:
|
|
DOMAIN: "https://vw.domain.tld"
|
|
volumes:
|
|
- ./vw-data/:/data/
|
|
ports:
|
|
- 80:80
|
|
```
|
|
|
|
<br>
|
|
|
|
## Get in touch
|
|
|
|
Have a question, suggestion or need help? Join our community on [Matrix](https://matrix.to/#/#vaultwarden:matrix.org), [GitHub Discussions](https://github.com/dani-garcia/vaultwarden/discussions) or [Discourse Forums](https://vaultwarden.discourse.group/).
|
|
|
|
Encountered a bug or crash? Please search our issue tracker and discussions to see if it's already been reported. If not, please [start a new discussion](https://github.com/dani-garcia/vaultwarden/discussions) or [create a new issue](https://github.com/dani-garcia/vaultwarden/issues/). Ensure you're using the latest version of Vaultwarden and there aren't any similar issues open or closed!
|
|
|
|
<br>
|
|
|
|
## Contributors
|
|
|
|
Thanks for your contribution to the project!
|
|
|
|
[](https://github.com/dani-garcia/vaultwarden/graphs/contributors)<br>
|
|
[](https://github.com/dani-garcia/vaultwarden/graphs/contributors)
|
|
|
|
<br>
|
|
|
|
## Disclaimer
|
|
|
|
**This project is not associated with [Bitwarden](https://bitwarden.com/) or Bitwarden, Inc.**
|
|
|
|
However, one of the active maintainers for Vaultwarden is employed by Bitwarden and is allowed to contribute to the project on their own time. These contributions are independent of Bitwarden and are reviewed by other maintainers.
|
|
|
|
The maintainers work together to set the direction for the project, focusing on serving the self-hosting community, including individuals, families, and small organizations, while ensuring the project's sustainability.
|
|
|
|
**Please note:** We cannot be held liable for any data loss that may occur while using Vaultwarden. This includes passwords, attachments, and other information handled by the application. We highly recommend performing regular backups of your files and database. However, should you experience data loss, we encourage you to contact us immediately.
|
|
|
|
<br>
|
|
|
|
## Bitwarden_RS
|
|
|
|
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.<br>
|
|
Please see [#1642 - v1.21.0 release and project rename to Vaultwarden](https://github.com/dani-garcia/vaultwarden/discussions/1642) for more explanation.
|