同步来源：树洞剪藏 源站剪藏 ID：366 原文地址：https://github.com/ray-d-song/web-archive/blob/main/docs/README_zh.md

打开原文 · 打开源站剪藏快照

---

web-archive/docs/README_zh.md at main · Ray-D-Song/web-archive / /blob/show" data-turbo-transient=true>

Skip to content

Navigation Menu

Ray-D-Song

/

web-archive

Type / to search

Create new...

Issues

Pull requests

You have unread notifications

Code

Issues 6

Pull requests 1

Actions

Projects 0

Security

Insights

Additional navigation options

{{ message }}

Open in github.dev ,>" target=_blank rel="noopener noreferrer">Open in a new github.dev tab Open in codespace

Files

main

t

.github

.husky

docs

.vitepress

en

imgs

README_zh.md

about.md

contribute.md

deploy.md

feat.md

index.md

usage.md

packages

scripts

.gitignore

LICENSE

README.md

eslint.config.mjs

package.json

pnpm-lock.yaml

pnpm-workspace.yaml

tsconfig.root.json

Breadcrumbs web-archive / docs / README_zh.md

Latest commit

Ray-D-Song

doc: update

cdad821 · last month Nov 10, 2024

History History

File metadata and controls

Preview

Code

Blame

155 lines (120 loc) · 5.84 KB Code 55% faster with GitHub Copilot " data-hotkey-scope=read-only-cursor-text-area class=sf-hidden> " class=sf-hidden>

Raw ,>"> ,>" class=sf-hidden>

Web Archive

Web Archive 是一个网页归档工具，包含以下几个部分：

浏览器插件：将网页保存为网页快照，并上传到服务端。

服务端： 接收浏览器插件上传的快照，并存储在数据库和存储桶中。

web 客户端： 查询快照并展示。

服务端基于 Cloudflare Worker 的全套服务，包含 D1 数据库、R2 存储桶。

Why

大多数网页归档工具，比如 archivebox，都是基于服务器调用无头浏览器抓取的方式进行归档。

这种做法的弊端是 知乎、medium 这种需要登录的网站操作很麻烦，需要配置 token 或 cookie。

同时无头浏览器对服务器的要求也比较高，大多数都是 nas 用户在使用。

web-archive 是一个完全免费、无门槛的方案，而且 Cloudflare 可以非常方便的将数据迁移回本地转为 self-host。

feat & roadmap

文件夹分类

页面预览图

标题关键字查询

橱窗，可以分享自己抓取的页面

移动端适配

tag 分类

将页面保存为 markdown 阅读模式

划词高亮？

部署指南

Github Actions 一键部署(推荐)

点击上面的按钮，按照 Cloudflare 的指引完成部署。

Important R2 存储桶是需要在 Cloudflare 面板上手动开通的功能，请开通后再进行部署或者失败后 re-run Github Actions。 仅需开通 R2 功能，不需要创建存储桶，存储桶会在部署时自动创建。

Note 创建令牌时，直接选择 编辑 Cloudflare Workers 模版，再手动添加 D1 编辑 权限。

部署后请尽快登录，首个登录的用户会被设置为管理员。

命令部署

要求本地安装了 node 环境。

命令部署时更新比较麻烦, 推荐实用 Github actions 部署。

0. 下载代码

在 release 页面下载最新的 service.zip，解压后在根目录执行后续操作。

1. 登录

npx wrangler login

2. 创建 r2 存储桶

npx wrangler r2 bucket create web-archive

成功输出：

⛅️ wrangler 3.78.10 (update available 3.80.4)

Creating bucket web-archive with default storage class set to Standard. Created bucket web-archive with default storage class set to Standard.

3. 创建 d1 数据库

创建数据库

npx wrangler d1 create web-archive

执行输出：

⛅️ wrangler 3.78.10 (update available 3.80.4)

✅ Successfully created DB ' web-archive ' in region UNKNOWN Created your new D1 database.

[[d1_databases]] binding = " DB " # i.e. available in your Worker on env.DB database_name = " web-archive " database_id = " xxxx-xxxx-xxxx-xxxx-xxxx "

拷贝最后一行，替换 wrangler.toml 文件中 database_id 的值。

然后执行初始化 sql:

npx wrangler d1 migrations apply web-archive --remote

成功输出：

🌀 Executing on remote database web-archive (7fd5a5ce-79e7-4519-a5fb-2f9a3af71064): 🌀 To execute on your local development database, remove the --remote flag from your wrangler command. Note: if the execution fails to complete, your DB will return to its original state and you can safely retry. ├ 🌀 Uploading 7fd5a5ce-79e7-4519-a5fb-2f9a3af71064.0a40ff4fc67b5bdf.sql │ 🌀 Uploading complete. │ 🌀 Starting import... 🌀 Processed 9 queries. 🚣 Executed 9 queries in 0.00 seconds (13 rows read, 13 rows written) Database is currently at bookmark 00000001-00000005-00004e2b-c977a6f2726e175274a1c75055c23607. ┌────────────────────────┬───────────┬──────────────┬────────────────────┐ │ Total queries executed │ Rows read │ Rows written │ Database size (MB) │ ├────────────────────────┼───────────┼──────────────┼────────────────────┤ │ 9 │ 13 │ 13 │ 0.04 │ └────────────────────────┴───────────┴──────────────┴────────────────────┘

4. 部署服务

部署服务

npx wrangler pages deploy

成功输出：

The project you specified does not exist: " web-archive " . Would you like to create it ? ❯ Create a new project ✔ Enter the production branch name: … dev ✨ Successfully created the ' web-archive ' project. ▲ [WARNING] Warning: Your working directory is a git repo and has uncommitted changes

To silence this warning, pass in --commit-dirty=true

🌎 Uploading... (3/3)

✨ Success ! Uploaded 3 files (3.29 sec)

✨ Compiled Worker successfully ✨ Uploading Worker bundle ✨ Uploading _routes.json 🌎 Deploying... ✨ Deployment complete ! Take a peek over at https://web-archive-xxxx.pages.dev

使用指南

在 release 页面下载最新的 extension.zip，解压后安装到浏览器中。

首次安装后，需要输入 API 地址和密钥，API 地址是服务地址，密钥就是首个用户（管理员）的密码。

在文件夹页面，你可以设置某个页面是否在橱窗中展示。

橱窗地址：/#/showcase/folder

You can’t perform that action at this time.

set 限制解除

web-archive/docs/README_zh.md at main · Ray-D-Song/web-archive