Yuanji's Blog

自建 vaultwarden(a.k.a bitwarden_rs)

📅 2021/01/30 ( 2021/05/13 更新 ) | 🏷️

20210513 更新:鉴于 bitwarden_rs 已经更名为 vaultwarden 本文也对关键词加以更新。

背景

一直以来,大概近 5 年的时间我一直在使用着一款叫做 Enpass 的密码管理软件,当初选择这款软件是考虑到

不过最近用上了新手机之后,它的自动补全方式就开始屡屡失效,虽然之前也有过但并没有这么频繁,于是想着利用这个机会研究一下其他的选择。经过一番比较,基本上把目光投向了 bitwarden。同样支持多平台,实际上我发现桌面端如果只是浏览器使用的话安装一个浏览器插件就行,那个用 Web 技术写的桌面客户端显得非常鸡肋(比起 Enpass,可以说非常卡顿)。不过基本上我在桌面端基本也只使用浏览器填充密码,所以问题不大。

至于 bitwarden 的收费方式虽然是订阅收费但价格可以说真的非常低了,只是它这种自己提供后端同步的方式总觉得心理上有点儿怪怪的。但好在除了使用它官方的服务之外,还有自建服务这条路,这里就不得不说 vaultwarden(原本叫作:bitwarden_rs) 这个第三方实现的开源后端了,比起官方提供的方式,系统资源的要求上要低的多。

自建 vaultwarden

vaultwarden 的 GitHub 页面上提供了各种部署方式,为了方便维护,我选择了使用 docker-compose 的方式。有了之前自建服务的经验,基本上分为:

  1. 创建 docker-compose.yml
  2. 启动服务
  3. acme.sh 申请 HTTPS 证书(如果已经有申请过证书可以跳过)
  4. 用 NGINX 配置反向代理

创建 docker-compose.yml

 1version: '3'
 2services:
 3  vaultwarden:
 4    image: vaultwarden/server:latest
 5    restart: always
 6    ports:
 7      - "3080:80"
 8      - "3012:3012"
 9    environment:
10      DOMAIN: 'https://bw.tokyo-1.gimo.me/'
11      SIGNUPS_ALLOWED: 'true'
12      WEBSOCKET_ENABLED: 'true'
13    volumes:
14      - ./data:/data

启动服务

直接在 docker-compose.yml 所在目录

1docker-compose up -d

如果要停止服务,只要 docker-compose down,因为我在 docker-compose.yml 的配置,数据直接保存在当前目录的 data 目录。所以备份的话就是备份这个目录即可。

申请 HTTPS 证书

之前使用过 acme.sh 这个工具,申请证书非常方便直观,我习惯有一台服务器就先申请一张 wildcard 证书再说。因为我的域名托管在 cloudflare,在使用 acme.sh 前先设置 accout id 和 token 后就可以一键申请了。

1export CF_Account_ID=YOUR_ACCOUNT_ID
2export CF_Token=YOUR_TOKEN
3acme.sh --issue -d tokyo-1.gimo.me -d '*.tokyo-1.gimo.me' --dns dns_cf

申请成功后就是安装证书了

1acme.sh --install-cert -d "tokyo-1.gimo.me" \
2--key-file /etc/ssl/tokyo-1.gimo.me/privkey.pem \
3--fullchain-file /etc/ssl/tokyo-1.gimo.me/fullchain.pem \
4--capath /etc/ssl/tokyo-1.gimo.me/chain.pem \
5--reloadcmd "sudo systemctl reload nginx.service"

然后设置一个定时脚本用来更新证书(这取决于你安装 acme.sh 的方式,似乎默认的安装方式会自动设置一个 cronjob,不过我的服务器用的是 Arch 仓库里的版本,需要自己配置一下实际上也非常简单,就是创建一个 systemd timer/service。

 1# /etc/systemd/system/acme_letsencrypt.timer
 2[Unit]
 3Description=Daily renewal of Let's Encrypt's certificates
 4
 5[Timer]
 6OnCalendar=daily
 7RandomizedDelaySec=1h
 8Persistent=true
 9
10[Install]
11WantedBy=timers.target
 1# /etc/systemd/system/acme_letsencrypt.service
 2[Unit]
 3Description=Renew Let's Encrypt certificates using acme.sh
 4After=network-online.target
 5
 6[Service]
 7Type=oneshot
 8Environment="HOME=/home/yuanji"
 9ExecStart=/usr/bin/acme.sh --cron
10SuccessExitStatus=0 2

配置 NGINX

vaultwarden 的 wiki 里包含了各种各样的文档,其中我对照 https://github.com/dani-garcia/vaultwarden/wiki/Proxy-examples 里的例子稍作修改如下。

 1# Define the server IP and ports here.
 2upstream bitwardenrs-default { server 127.0.0.1:3080; }
 3upstream bitwardenrs-ws { server 127.0.0.1:3012; } 
 4                                                                                       
 5# Redirect HTTP to HTTPS
 6server {                               
 7    listen 80;
 8    server_name bw.tokyo-1.gimo.me;
 9    return 301 https://$host$request_uri;
10} 
11
12server {
13    listen 443 ssl http2;
14    server_name bw.tokyo-1.gimo.me;
15
16        # SSL
17        ssl_certificate /etc/ssl/tokyo-1.gimo.me/fullchain.pem;
18        ssl_certificate_key /etc/ssl/tokyo-1.gimo.me/privkey.pem;
19        ssl_trusted_certificate /etc/ssl/tokyo-1.gimo.me/chain.pem;
20
21    client_max_body_size 128M;
22
23    location / {
24      proxy_set_header Host $host;
25      proxy_set_header X-Real-IP $remote_addr;
26      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
27      proxy_set_header X-Forwarded-Proto $scheme;
28
29      proxy_pass http://bitwardenrs-default;
30    }
31
32    location /notifications/hub/negotiate {
33      proxy_set_header Host $host;
34      proxy_set_header X-Real-IP $remote_addr;
35      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
36      proxy_set_header X-Forwarded-Proto $scheme;
37
38      proxy_pass http://bitwardenrs-default;
39    }
40
41    location /notifications/hub {
42      proxy_set_header Upgrade $http_upgrade;
43      proxy_set_header Connection $http_connection;
44      proxy_set_header X-Real-IP $remote_addr;
45
46      proxy_pass http://bitwardenrs-ws;
47    }
48}

最后

搭好服务后访问域名就可以使用了,vaultwarden 的 docker 镜像除了包含了后端的 API 之外还自带了一个修改过的官方 Web UI,通过它可以直接导入从 Enpass 导出的 json 文件,不过 Enpass 的 attachments 并不会自动转成 bitwarden 里的,稍微需要做点儿手动干预。另外如果只是自己使用的话可以把注册功能禁用,设置 docker 的环境变量 SIGNUPS_ALLOWED: 'false' 即可。

在使用了几天之后发现没有特别的问题,只是我上服务器查看了下 NGINX 的日志发现好多奇奇怪怪的爬虫、探测请求,虽然说这些无脑的脚本不至于构成什么大问题,但感觉还是稍加保护为好,好奇的读者可能会发现上文配置里的 https://bw.tokyo-1.gimo.me/ 解析到了一个私有 IP 地址,至于细节,请看下一遍日记我会介绍一下如果使用 WireGuard 来搭建一个简单的 VPN 隧道