Spiegel von
https://github.com/dani-garcia/vaultwarden.git
synchronisiert 2024-11-16 04:12:53 +01:00
113 Zeilen
5,1 KiB
Markdown
113 Zeilen
5,1 KiB
Markdown
# Vaultwarden
|
|
|
|
[](https://github.com/dani-garcia/vaultwarden/actions/workflows/build.yml)
|
|
[](https://github.com/dani-garcia/vaultwarden/pkgs/container/vaultwarden)
|
|
[](https://hub.docker.com/r/vaultwarden/server)
|
|
[](https://quay.io/repository/vaultwarden/server)
|
|
[](https://deps.rs/repo/github/dani-garcia/vaultwarden)
|
|
[](https://github.com/dani-garcia/vaultwarden/releases/latest)
|
|
[](https://github.com/dani-garcia/vaultwarden/blob/main/LICENSE.txt)
|
|
[](https://matrix.to/#/#vaultwarden:matrix.org)
|
|
|
|
Alternative implementation of the Bitwarden server API written in Rust and compatible with [upstream Bitwarden clients](https://bitwarden.com/download/).
|
|
|
|
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](https://github.com/dani-garcia/vaultwarden/discussions/1642) for more explanation.
|
|
>
|
|
> This project is not associated with the [Bitwarden](https://bitwarden.com/) project nor Bitwarden, Inc.
|
|
|
|
> [!TIP]
|
|
> [Please report any bugs or suggestions to us directly](#get-in-touch), 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:
|
|
|
|
```sh
|
|
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](https://github.com/dani-garcia/vaultwarden/wiki/Enabling-HTTPS) or using a [third-party reverse proxy](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](https://github.com/dani-garcia/vaultwarden/wiki/Proxy-examples).
|
|
|
|
## Usage
|
|
See the [vaultwarden wiki](https://github.com/dani-garcia/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](https://github.com/dani-garcia/vaultwarden/discussions) or [the forum](https://vaultwarden.discourse.group/).
|
|
|
|
### Issues
|
|
If you spot any bugs or crashes with vaultwarden itself, please [create an issue](https://github.com/dani-garcia/vaultwarden/issues/). 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](https://matrix.to/#/#vaultwarden:matrix.org) room on Matrix. Feel free to join us!
|
|
|
|
## Sponsors
|
|
Thanks for your contribution to the project!
|
|
|
|
<!--
|
|
<table>
|
|
<tr>
|
|
<td align="center">
|
|
<a href="https://github.com/username">
|
|
<img src="https://avatars.githubusercontent.com/u/725423?s=75&v=4" width="75px;" alt="username"/>
|
|
<br />
|
|
<sub><b>username</b></sub>
|
|
</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br/>
|
|
-->
|
|
|
|
<table>
|
|
<tr>
|
|
<td align="center">
|
|
<a href="https://github.com/themightychris" style="width: 75px">
|
|
<sub><b>Chris Alfano</b></sub>
|
|
</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center">
|
|
<a href="https://github.com/numberly" style="width: 75px">
|
|
<sub><b>Numberly</b></sub>
|
|
</a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center">
|
|
<a href="https://github.com/IQ333777" style="width: 75px">
|
|
<sub><b>IQ333777</b></sub>
|
|
</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|