From 28891fd16a1ef1ed6e8a19ec54fba91f07fab393 Mon Sep 17 00:00:00 2001 From: tianma-if Date: Wed, 26 Aug 2026 19:04:25 +0800 Subject: [PATCH] docs(docker): use GHCR as official image source --- README.md | 19 +++++++++---------- README.zh-CN.md | 16 +++++++--------- apps/api/src/demo-seed-data.ts | 14 ++++---------- apps/site/public/install.sh | 2 -- docs/demo-sample-note.md | 7 ++----- docs/demo-sample-note.zh-CN.md | 7 ++----- docs/deploy-docker.md | 32 +++++++++----------------------- docs/deploy-docker.zh-CN.md | 32 +++++++++++++------------------- 8 files changed, 46 insertions(+), 83 deletions(-) diff --git a/README.md b/README.md index 07c42332..b425937e 100644 --- a/README.md +++ b/README.md @@ -97,22 +97,21 @@ Complete setup in 5 simple web steps: ### Option C: Docker on a VPS or NAS -For a VPS or NAS outside mainland China, use the GitHub-hosted installer and -GHCR image: +Use the GitHub-hosted installer and the official GHCR image: ```sh curl -fsSL https://edgeever.org/install.sh | bash ``` -For a VPS or NAS located in mainland China, use the Tencent COS installer and -Tencent TCR image for faster, more reliable downloads: +The command pulls the latest image, generates an administrator password, starts +EdgeEver with Docker Compose, and schedules daily automatic updates. -```sh -curl -fsSL https://edgeever-installer-1256854452.cos.ap-guangzhou.myqcloud.com/install.sh | bash -s -- --mirror tcr -``` - -Both commands pull the latest image, generate an administrator password, start -EdgeEver with Docker Compose, and schedule daily automatic updates. +The official EdgeEver container image is hosted on GitHub Container Registry +(GHCR). Some network environments in mainland China may experience slow +connections or timeouts. If the image cannot be pulled normally, configure an +available network proxy or a trusted registry mirror before deployment. Users +are responsible for evaluating the availability and security of +third-party network and registry services. See the [Docker deployment guide](docs/deploy-docker.md) for manual deployment and configuration. diff --git a/README.zh-CN.md b/README.zh-CN.md index f223d826..2013a6d7 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -97,22 +97,20 @@ Cloudflare 在线部署可以选择以下两种方式之一： ### 方案三：在 VPS 或 NAS 上使用 Docker -如果 VPS 或 NAS 位于中国大陆境外，使用 GitHub 托管的安装脚本和 GHCR 镜像： +使用 GitHub 托管的安装脚本和官方 GHCR 镜像： ```sh curl -fsSL https://edgeever.org/install.sh | bash ``` -如果 VPS 或 NAS 位于中国大陆境内，使用腾讯云 COS 安装脚本和腾讯云 TCR 镜像， -下载速度和稳定性通常更好： - -```sh -curl -fsSL https://edgeever-installer-1256854452.cos.ap-guangzhou.myqcloud.com/install.sh | bash -s -- --mirror tcr -``` - -两种方式都会自动拉取最新镜像、生成管理员密码、使用 Docker Compose 启动 +该命令会自动拉取最新镜像、生成管理员密码、使用 Docker Compose 启动 EdgeEver，并设置每日自动更新。手动部署与配置说明见 [Docker 部署文档](docs/deploy-docker.zh-CN.md)。 +EdgeEver 官方容器镜像托管于 GitHub Container Registry（GHCR）。部分中国大陆 +网络环境可能出现连接缓慢或超时。如果无法正常拉取，请在部署前自行配置可用的 +网络代理或可信的镜像加速服务。第三方网络及镜像服务的可用性和安全性由 +用户自行评估。 + --- ## 多账号登录 diff --git a/apps/api/src/demo-seed-data.ts b/apps/api/src/demo-seed-data.ts index 0b79e7e7..dd220f29 100644 --- a/apps/api/src/demo-seed-data.ts +++ b/apps/api/src/demo-seed-data.ts @@ -199,13 +199,10 @@ sequenceDiagram 1. **Cloudflare Serverless（推荐，永久 100% 免费）**：基于 Workers + D1 数据库 + R2 对象存储构建，完全处于 Cloudflare 免费额度内，无需采购服务器，免运维、免证书续期。 2. **Docker 一键自建（VPS / NAS / 家用服务器）**： \`\`\`sh - # 国际 VPS / NAS 极速安装（GHCR 镜像） + # 官方 GHCR 镜像 curl -fsSL https://edgeever.org/install.sh | bash - - # 大陆地区 VPS / NAS 镜像加速（腾讯云 TCR 镜像） - curl -fsSL https://edgeever-installer-1256854452.cos.ap-guangzhou.myqcloud.com/install.sh | bash -s -- --mirror tcr \`\`\` - 单命令自动配置 Docker Compose 环境，并内置每日定时自动更新。 + 单命令自动配置 Docker Compose 环境，并内置每日定时自动更新。部分中国大陆网络环境可能需要自行配置可用的网络代理或可信的镜像加速服务，才能正常访问 GHCR。 ### 💾 绝对的数据自由：无损 ZIP 导入与导出 在**个人中心 → 导入与导出**中，可随时将完整笔记库打包导出为结构清晰的 ZIP 压缩包。解压后即为包含标准 YAML Front Matter、相对路径附件图片与完整修订版本的纯 Markdown 文件树，随时可在 Obsidian、VS Code 等任意工具中无缝打开，永不担心平台绑定！ @@ -420,13 +417,10 @@ Embed PDFs, spreadsheets, archives, and multimedia files directly in notes for p 1. **Cloudflare Serverless (Recommended, 100% Free Forever)**: Runs entirely within Cloudflare's free tier (Workers + D1 SQLite + R2 Storage). No server bills, no VPS maintenance. 2. **Docker One-Command Deployment (VPS / NAS / Home Server)**: \`\`\`sh - # International VPS / NAS installer (GHCR image) + # Official GHCR image curl -fsSL https://edgeever.org/install.sh | bash - - # Mainland China mirror installer (Tencent TCR image) - curl -fsSL https://edgeever-installer-1256854452.cos.ap-guangzhou.myqcloud.com/install.sh | bash -s -- --mirror tcr \`\`\` - Configures Docker Compose and automated daily background updates with one command. + Configures Docker Compose and automated daily background updates with one command. Some network environments in mainland China may require an available network proxy or a trusted registry mirror to access GHCR. ### 💾 Complete Data Freedom: Lossless ZIP Portability Export your entire library at any time from **Profile → Import and export**. The archive contains pure Markdown files with standard YAML Front Matter, relative media paths, and full revision histories—compatible with Obsidian, VS Code, and any plain text editor. diff --git a/apps/site/public/install.sh b/apps/site/public/install.sh index d250754d..807dd63b 100755 --- a/apps/site/public/install.sh +++ b/apps/site/public/install.sh @@ -108,10 +108,8 @@ Install or upgrade EdgeEver with Docker Compose. Usage: curl -fsSL https://edgeever.org/install.sh | bash - curl -fsSL https://edgeever-installer-1256854452.cos.ap-guangzhou.myqcloud.com/install.sh | bash -s -- --mirror tcr Options: - --mirror ghcr|tcr Select the image registry (default: ghcr) --image IMAGE Use a custom image repository --version TAG Deploy an image tag (default: latest) --compose-url URL Download Compose configuration from URL diff --git a/docs/demo-sample-note.md b/docs/demo-sample-note.md index 849a3986..ca96cd3c 100644 --- a/docs/demo-sample-note.md +++ b/docs/demo-sample-note.md @@ -172,13 +172,10 @@ Embed PDFs, spreadsheets, archives, and multimedia files directly in notes for p 1. **Cloudflare Serverless (Recommended, 100% Free Forever)**: Runs entirely within Cloudflare's free tier (Workers + D1 SQLite + R2 Storage). No server bills, no VPS maintenance. 2. **Docker One-Command Deployment (VPS / NAS / Home Server)**: ```sh - # International VPS / NAS installer (GHCR image) + # Official GHCR image curl -fsSL https://edgeever.org/install.sh | bash - - # Mainland China mirror installer (Tencent TCR image) - curl -fsSL https://edgeever-installer-1256854452.cos.ap-guangzhou.myqcloud.com/install.sh | bash -s -- --mirror tcr ``` - Configures Docker Compose and automated daily background updates with one command. + Configures Docker Compose and automated daily background updates with one command. Some network environments in mainland China may require an available network proxy or a trusted registry mirror to access GHCR. ### 💾 Complete Data Freedom: Lossless ZIP Portability Export your entire library at any time from **Profile → Import and export**. The archive contains pure Markdown files with standard YAML Front Matter, relative media paths, and full revision histories—compatible with Obsidian, VS Code, and any plain text editor. diff --git a/docs/demo-sample-note.zh-CN.md b/docs/demo-sample-note.zh-CN.md index a9414822..7a3414c2 100644 --- a/docs/demo-sample-note.zh-CN.md +++ b/docs/demo-sample-note.zh-CN.md @@ -172,13 +172,10 @@ sequenceDiagram 1. **Cloudflare Serverless（推荐，永久 100% 免费）**：基于 Workers + D1 数据库 + R2 对象存储构建，完全处于 Cloudflare 免费额度内，无需采购服务器，免运维、免证书续期。 2. **Docker 一键自建（VPS / NAS / 家用服务器）**： ```sh - # 国际 VPS / NAS 极速安装（GHCR 镜像） + # 官方 GHCR 镜像 curl -fsSL https://edgeever.org/install.sh | bash - - # 大陆地区 VPS / NAS 镜像加速（腾讯云 TCR 镜像） - curl -fsSL https://edgeever-installer-1256854452.cos.ap-guangzhou.myqcloud.com/install.sh | bash -s -- --mirror tcr ``` - 单命令自动配置 Docker Compose 环境，并内置每日定时自动更新。 + 单命令自动配置 Docker Compose 环境，并内置每日定时自动更新。部分中国大陆网络环境可能需要自行配置可用的网络代理或可信的镜像加速服务，才能正常访问 GHCR。 ### 💾 绝对的数据自由：无损 ZIP 导入与导出 在**个人中心 → 导入与导出**中，可随时将完整笔记库打包导出为结构清晰的 ZIP 压缩包。解压后即为包含标准 YAML Front Matter、相对路径附件图片与完整修订版本的纯 Markdown 文件树，随时可在 Obsidian、VS Code 等任意工具中无缝打开，永不担心平台绑定！ diff --git a/docs/deploy-docker.md b/docs/deploy-docker.md index da255fd5..70d5de83 100644 --- a/docs/deploy-docker.md +++ b/docs/deploy-docker.md @@ -21,17 +21,16 @@ With Docker Compose v2 already installed: curl -fsSL https://edgeever.org/install.sh | bash ``` -Use Tencent Cloud TCR in mainland China: - -```sh -curl -fsSL https://edgeever-installer-1256854452.cos.ap-guangzhou.myqcloud.com/install.sh | bash -s -- --mirror tcr -``` - The installer creates `~/edgeever`, generates an administrator password, pulls `latest`, starts the container, and waits for it to become healthy. Run the same command again to upgrade without replacing the password or `/data` volume. The -mainland command downloads the installer and Compose configuration from Tencent -COS and pulls the image from Tencent TCR. +installer and Compose configuration use the official GHCR image. + +Some network environments in mainland China may experience slow connections or +timeouts when accessing GHCR. If the image cannot be pulled normally, configure +an available network proxy or a trusted registry mirror before deployment. +Users are responsible for evaluating the availability and security of +third-party network and registry services. By default, the installer schedules `~/edgeever/update.sh` with the current user's crontab at 04:17 server time every day. The updater refreshes the Compose @@ -64,21 +63,8 @@ storage are ready. ### Image registry -The default image is `ghcr.io/tianma-if/edgeever`. Users in mainland China can -switch to Tencent Cloud TCR: - -```sh -export EDGE_EVER_IMAGE=ccr.ccs.tencentyun.com/edgeever/edgeever -export EDGE_EVER_VERSION=vX.Y.Z -docker compose pull -docker compose up -d -``` - -The public TCR image requires no `docker login` and supports `linux/amd64` and -`linux/arm64`. Formal releases publish the same version tags and `latest` to -GHCR and TCR. TCR is independently built from the same verified Git commit -inside Tencent Cloud, so its registry digest may differ from GHCR. Pin -`EDGE_EVER_VERSION` to a release tag in production. +The official image is `ghcr.io/tianma-if/edgeever` and supports `linux/amd64` +and `linux/arm64`. Pin `EDGE_EVER_VERSION` to a release tag in production. Compose creates one named volume. Everything that must survive a container replacement is under `/data`: diff --git a/docs/deploy-docker.zh-CN.md b/docs/deploy-docker.zh-CN.md index d5ae3035..d91846cd 100644 --- a/docs/deploy-docker.zh-CN.md +++ b/docs/deploy-docker.zh-CN.md @@ -16,12 +16,17 @@ Cloudflare 使用 Workers + D1 + R2。 已安装 Docker Compose v2 的主机可直接执行： ```sh -curl -fsSL https://edgeever-installer-1256854452.cos.ap-guangzhou.myqcloud.com/install.sh | bash -s -- --mirror tcr +curl -fsSL https://edgeever.org/install.sh | bash ``` 脚本会创建 `~/edgeever`、生成管理员密码、拉取 `latest`、启动容器并等待健康 -检查通过。中国大陆命令从腾讯云 COS 获取脚本与 Compose 配置，并从腾讯云 TCR -拉取镜像。再次执行同一命令即可升级，已有密码和 `/data` 卷保持不变。 +检查通过。安装脚本和 Compose 配置使用官方 GHCR 镜像。再次执行同一命令即可 +升级，已有密码和 `/data` 卷保持不变。 + +EdgeEver 官方容器镜像托管于 GitHub Container Registry（GHCR）。部分中国大陆 +网络环境可能出现连接缓慢或超时。如果无法正常拉取，请在部署前自行配置可用的 +网络代理或可信的镜像加速服务。第三方网络及镜像服务的可用性和安全性由 +用户自行评估。 默认情况下，脚本会通过当前用户的 crontab 设置每日自动更新，于服务器本地时间 04:17 执行 `~/edgeever/update.sh`。更新程序会刷新 Compose 配置、拉取已配置的 @@ -31,11 +36,11 @@ curl -fsSL https://edgeever-installer-1256854452.cos.ap-guangzhou.myqcloud.com/i `EDGE_EVER_AUTO_UPDATE=false` 可关闭自动更新。如果系统没有 `crontab`，安装脚本 会保留 `update.sh`，并提示通过 NAS 的任务计划程序执行。 -海外服务器可去掉 `--mirror tcr` 使用 GHCR。按需使用 `--version vX.Y.Z`、 -`--port PORT` 或 `--install-dir DIR`；执行以下命令可查看全部参数： +按需使用 `--version vX.Y.Z`、`--port PORT` 或 `--install-dir DIR`；执行以下命令 +可查看全部参数： ```sh -curl -fsSL https://edgeever-installer-1256854452.cos.ap-guangzhou.myqcloud.com/install.sh | bash -s -- --help +curl -fsSL https://edgeever.org/install.sh | bash -s -- --help ``` ## 手动使用 Compose @@ -54,19 +59,8 @@ docker compose ps ### 镜像地址 -默认镜像为 `ghcr.io/tianma-if/edgeever`。中国大陆用户可以切换到腾讯云 TCR： - -```sh -export EDGE_EVER_IMAGE=ccr.ccs.tencentyun.com/edgeever/edgeever -export EDGE_EVER_VERSION=vX.Y.Z -docker compose pull -docker compose up -d -``` - -腾讯云公共镜像无需执行 `docker login`，支持 `linux/amd64` 与 `linux/arm64`。 -正式发布会向 GHCR 和 TCR 写入相同的版本标签与 `latest`。TCR 在腾讯云侧根据 -同一个已验证 Git 提交独立构建，因此 Registry Digest 可以与 GHCR 不同。生产 -环境应通过 `EDGE_EVER_VERSION` 固定正式版本标签。 +官方镜像为 `ghcr.io/tianma-if/edgeever`，支持 `linux/amd64` 与 `linux/arm64`。 +生产环境应通过 `EDGE_EVER_VERSION` 固定正式版本标签。 Compose 会创建一个命名卷。所有需要在容器替换后保留的数据都位于 `/data`：