From 28333f0e9b124a5c82aea7cf43325aff26a27379 Mon Sep 17 00:00:00 2001 From: shuaiplus <2327005759@qq.com> Date: Wed, 10 Jun 2026 16:51:07 +0800 Subject: [PATCH] feat: update README to enhance PWA and Passkey features descriptions --- README.md | 30 +++++++++++++++++++++++++----- README_EN.md | 40 ++++++++++++++++++++++++++++++---------- 2 files changed, 55 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 90f69c2..79715bd 100644 --- a/README.md +++ b/README.md @@ -34,16 +34,19 @@ | 能力 | Bitwarden | NodeWarden | 说明 | |---|---|---|---| | 网页密码库 | ✅ | ✅ | **原创Web Vault界面** | +| **PWA 支持** | ⚠️ 基础 | ✅ | **可安装、离线使用、App快捷方式** | +| **Web Vault 离线查看** | ❌ | ✅ | **网页端支持离线查看保险库** | +| **Passkey 登录** | ✅ | ✅ | **支持WebAuthn/FIDO2无密码登录** | | 全量同步 `/api/sync` | ✅ | ✅ | 已针对官方客户端做兼容优化 | | 附件上传 / 下载 | ✅ | ✅ | Cloudflare R2 或 KV | | Send | ✅ | ✅ | 支持文本与文件 Send | | 导入 / 导出 | ✅ | ✅ | 支持 Bitwarden JSON / CSV / **ZIP 导入(包括附件)** | -| **云端备份中心** | ❌ | ✅ | **支持 WebDAV / S3 定时备份** | +| **云端备份中心** | ❌ | ✅ | **支持 WebDAV / S3 定时备份(OneDrive/Google Drive等)** | | 密码提示(网页端) | ⚠️ 有限 | ✅ | **无需发送邮件** | | TOTP / Steam TOTP | ✅ | ✅ | 含 `steam://` 支持 | | 多用户 | ✅ | ✅ | 支持邀请码注册 | | 组织 / 集合 / 成员权限 | ✅ | ❌ | 未实现 | -| 登录 2FA | ✅ | ⚠️ 部分支持 | 当前仅支持用户级 TOTP | +| 登录 2FA | ✅ | ⚠️ 部分支持 | 支持TOTP和Passkey(作为第二因素) | | SSO / SCIM / 企业目录 | ✅ | ❌ | 未实现 | --- @@ -110,10 +113,27 @@ npm run dev:kv --- -## 云端备份说明 +## 主要特性 -- 远程备份支持 **WebDAV** 与 **E3** -- 勾选“包含附件”后: +### PWA 渐进式 Web 应用 + +- ✅ **可安装到桌面** - 像原生应用一样运行 +- ✅ **离线使用** - Service Worker 缓存,离线也能查看密码 +- ✅ **App 快捷方式** - 快速启动保险库、TOTP代码 +- ✅ **后台解密** - Web Worker 处理解密,不阻塞UI + +### Passkey 无密码登录 + +- ✅ **WebAuthn/FIDO2 支持** - 使用指纹、Face ID等登录 +- ✅ **PRF 密钥解锁** - Passkey 可直接解锁保险库 +- ✅ **官方客户端兼容** - Chromium系浏览器扩展可用Passkey登录 +- ✅ **多设备同步** - 支持iCloud、Google Password Manager等 + +### 云端备份说明 + +- 远程备份支持 **WebDAV** 与 **S3** +- 支持 **OneDrive**(通过Koofr)、**Google Drive**(通过Koofr)、**Cloudflare R2**、**Backblaze B2** 等 +- 勾选”包含附件”后: - ZIP 内仍只包含 `db.json` 与 `manifest.json` - 真实附件单独存放在 `attachments/` - 后续备份会按稳定 blob 名复用已有附件,不会每次全量重传 diff --git a/README_EN.md b/README_EN.md index 86efa7a..c60eb82 100644 --- a/README_EN.md +++ b/README_EN.md @@ -37,16 +37,19 @@ | Capability | Bitwarden | NodeWarden | Notes | |---|---|---|---| | Web Vault | ✅ | ✅ | **Original Web Vault interface** | +| **PWA Support** | ⚠️ Basic | ✅ | **Installable, offline-capable, app shortcuts** | +| **Web Vault Offline Access** | ❌ | ✅ | **Web client supports offline vault viewing** | +| **Passkey Login** | ✅ | ✅ | **WebAuthn/FIDO2 passwordless login** | | Full sync `/api/sync` | ✅ | ✅ | Compatibility optimized for official clients | | Attachment upload / download | ✅ | ✅ | Cloudflare R2 or KV | | Send | ✅ | ✅ | Supports both text and file Sends | | Import / Export | ✅ | ✅ | Supports Bitwarden JSON / CSV / **ZIP import with attachments** | -| **Cloud Backup Center** | ❌ | ✅ | **Scheduled backup to WebDAV / E3** | +| **Cloud Backup Center** | ❌ | ✅ | **WebDAV / S3 scheduled backup (OneDrive/Google Drive etc.)** | | Password hint (web) | ⚠️ Limited | ✅ | **No email required** | | TOTP / Steam TOTP | ✅ | ✅ | Includes `steam://` support | | Multi-user | ✅ | ✅ | Invite-based registration | | Organizations / Collections / Member roles | ✅ | ❌ | Not implemented | -| Login 2FA | ✅ | ⚠️ Partial | Currently only user-level TOTP | +| Login 2FA | ✅ | ⚠️ Partial | TOTP and Passkey (as second factor) | | SSO / SCIM / Enterprise directory | ✅ | ❌ | Not implemented | --- @@ -99,17 +102,34 @@ npm run dev:kv --- -## Cloud Backup Notes +## Key Features -- Remote backup supports **WebDAV** and **E3** +### PWA Progressive Web App + +- ✅ **Install to desktop** - Runs like a native app +- ✅ **Offline usage** - Service Worker caching, view passwords offline +- ✅ **App shortcuts** - Quick launch vault, TOTP codes +- ✅ **Background decryption** - Web Worker handles decryption without blocking UI + +### Passkey Passwordless Login + +- ✅ **WebAuthn/FIDO2 support** - Login with fingerprint, Face ID, etc. +- ✅ **PRF key unlock** - Passkey can unlock vault directly +- ✅ **Official client compatibility** - Chromium browser extension supports Passkey login +- ✅ **Multi-device sync** - Supports iCloud, Google Password Manager, etc. + +### Cloud Backup Notes + +- Remote backup supports **WebDAV** and **S3** +- Supports **OneDrive** (via Koofr), **Google Drive** (via Koofr), **Cloudflare R2**, **Backblaze B2**, etc. - When `Include attachments` is enabled: -- the ZIP still contains only `db.json` and `manifest.json` -- actual attachment files are stored separately under `attachments/` -- later backups reuse existing attachments by stable blob name instead of re-uploading everything every time + - the ZIP still contains only `db.json` and `manifest.json` + - actual attachment files are stored separately under `attachments/` + - later backups reuse existing attachments by stable blob name instead of re-uploading everything every time - During remote restore: -- required attachment files are loaded from `attachments/` on demand -- missing attachments are skipped safely -- skipped attachments do not leave broken rows in the restored database + - required attachment files are loaded from `attachments/` on demand + - missing attachments are skipped safely + - skipped attachments do not leave broken rows in the restored database ---