11 KiB
语言:本文档为简体中文翻译,点此查看英文原版 README.md。
Bitwarden Client API 的另一个服务器实现,使用 Rust 编写,兼容官方 Bitwarden 客户端 [免责声明],非常适合那些运行资源繁重的官方服务并不理想的自托管部署场景。
[!IMPORTANT] 使用本服务器时,请直接向我们报告任何缺陷或建议(见获取支持),无论你使用的是哪种客户端(移动端、桌面端、浏览器……)。请勿使用官方的 Bitwarden 支持渠道。
功能特性
它提供了 Bitwarden Client API 近乎完整的实现,包括:
- 个人保险库(Personal Vault)
- Send
- 附件(Attachments)
- 网站图标(Website icons)
- 个人 API 密钥(Personal API Key)
- 组织(Organizations)
- 多重/双因素认证(Multi/Two Factor Authentication)
- 紧急访问(Emergency Access)
- Vaultwarden 管理后台(Admin Backend)
- 改造过的 Web Vault 客户端(已内置在我们的容器中)
使用方法
[!IMPORTANT] web-vault 要求使用 HTTPS 以及安全上下文来启用 Web Crypto API。
这意味着只有在你启用 HTTPS后它才能工作。
我们还建议你使用反向代理。
安装和使用 Vaultwarden 的推荐方式是通过我们发布在 ghcr.io、docker.io 和 quay.io 上的容器镜像。 关于所提供标签的说明,请参阅该使用哪个容器镜像。
还有一些社区维护的软件包可供使用,但它们可能落后于最新版本,也可能在以何种方式配置 Vaultwarden 上有所偏离,详情见我们的 Wiki。
或者,你也可以自行构建 Vaultwarden。
Vaultwarden 基于 Rocket web 框架,该框架内置了对 TLS 的支持,但我们的建议是你配置一个反向代理(见代理示例)。
[!TIP] 想要了解更多关于如何安装、使用和配置 Vaultwarden 的示例,请查阅我们的 Wiki。
Docker/Podman CLI
拉取容器镜像,并为持久化存储挂载一个来自主机的卷。
如果你更倾向于使用 podman,可以把 docker 替换成 podman。
docker pull vaultwarden/server:latest
docker run --detach --name vaultwarden \
--env DOMAIN="https://vw.domain.tld" \
--volume /vw-data/:/data/ \
--restart unless-stopped \
--publish 127.0.0.1:8000:80 \
vaultwarden/server:latest
这会将所有持久化数据保留在 /vw-data/ 下,你可以根据需要调整该路径。
Docker Compose
要使用 Docker compose,你需要创建一个 compose.yaml,用于承载运行 Vaultwarden 容器的配置。
services:
vaultwarden:
image: vaultwarden/server:latest
container_name: vaultwarden
restart: unless-stopped
environment:
DOMAIN: "https://vw.domain.tld"
volumes:
- ./vw-data/:/data/
ports:
- 127.0.0.1:8000:80
获取支持
有问题、有建议,还是需要帮助?来加入我们在 Matrix、GitHub Discussions 或 Discourse 论坛 上的社区。
遇到了缺陷或崩溃?请搜索我们的议题跟踪器和讨论区,看看是否已有人报告。如果没有,请发起一个新的讨论或创建一个新的议题。请确认你使用的是 Vaultwarden 的最新版,并且没有类似的开放或已关闭议题!
贡献者
感谢你对本项目的贡献!
免责声明
本项目与 Bitwarden 或 Bitwarden, Inc. 并无关联。
不过,Vaultwarden 的一位活跃维护者受雇于 Bitwarden,并被允许利用自己的个人时间为本项目做出贡献。这些贡献独立于 Bitwarden,并由其他维护者进行评审。
维护者们共同协作来为项目设定方向,专注于服务自托管社区——包括个人、家庭以及小型组织——同时确保项目的可持续性。
请注意: 对于使用 Vaultwarden 期间可能发生的任何数据丢失,我们无法承担责任。这包括由该应用处理的密码、附件及其他信息。我们强烈建议你定期备份自己的文件和数据库。但倘若你遭遇了数据丢失,我们鼓励你立即与我们联系。
Bitwarden_RS
本项目曾名为 Bitwarden_RS,后更名为 Vaultwarden,以期将自己与官方的 Bitwarden 服务器区分开来,从而避免混淆以及商标/品牌方面的问题。
更多说明请参阅 #1642 - v1.21.0 版本发布及项目更名为 Vaultwarden。