mirror of
https://github.com/shuaiplus/nodewarden.git
synced 2026-06-20 13:00:39 +00:00
docs: update README and README_EN with clearer instructions for repository setup and synchronization
This commit is contained in:
@@ -77,7 +77,7 @@ English:[`README_EN.md`](./README_EN.md)
|
|||||||
>
|
>
|
||||||
>1. 先 Fork 本仓库,并命名为 **NodeWarden**(默认自动填写)
|
>1. 先 Fork 本仓库,并命名为 **NodeWarden**(默认自动填写)
|
||||||
>2. 进入新仓库,进入 `Actions` 页面,点击 `I understand my workflows, go ahead and enable them`,点击 `Switch to KV mode`,点击`Run Workflow`
|
>2. 进入新仓库,进入 `Actions` 页面,点击 `I understand my workflows, go ahead and enable them`,点击 `Switch to KV mode`,点击`Run Workflow`
|
||||||
>3. 成功后**在你自己的仓库中**点击下面的按钮,在打开的页面中将项目名称改为 **NodeWarden2**,并将 **JWT_SECRET** 设置为 32 位随机字符串。
|
>3. 成功后**在你自己的仓库中**点击下面的按钮,在打开的页面中将项目名称改为 **NodeWarden2**,并将 **JWT_SECRET** 设置为 32 位随机字符串。(不能选`创建专用 Git 存储库`)
|
||||||
>
|
>
|
||||||
> [](https://deploy.workers.cloudflare.com/?url=https://github.com/shuaiplus/NodeWarden)
|
> [](https://deploy.workers.cloudflare.com/?url=https://github.com/shuaiplus/NodeWarden)
|
||||||
>
|
>
|
||||||
@@ -90,9 +90,8 @@ English:[`README_EN.md`](./README_EN.md)
|
|||||||
|
|
||||||
> [!TIP]
|
> [!TIP]
|
||||||
> 同步方法(更新仓库):
|
> 同步方法(更新仓库):
|
||||||
>- 手动:打开你 Fork 的 GitHub 仓库,看到顶部同步提示后,点击 `Sync fork`。(不要点Contribute)
|
>- 手动:打开你 Fork 的 GitHub 仓库,看到顶部同步提示后,点击 `Sync fork`,点击`Update branch`
|
||||||
>- 自动:进入你的 Fork 仓库 -> `Actions`,点击 `I understand my workflows, go ahead and enable them`,启用后,`Sync upstream` 会在每天凌晨 3 点自动同步上游 `main`,并保留你当前的 [wrangler.toml](./wrangler.toml) 配置不被覆盖。
|
>- 自动:进入你的 Fork 仓库 -> `Actions`->`Sync upstream`->`Enable workflow`,会在每天凌晨 3 点自动同步上游。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### CLI 部署
|
### CLI 部署
|
||||||
|
|||||||
+5
-5
@@ -74,12 +74,12 @@
|
|||||||
>- **KV**: no card required; **single attachment / Send file limit is 25 MiB** (Cloudflare limit, not editable); **1 GB free storage**
|
>- **KV**: no card required; **single attachment / Send file limit is 25 MiB** (Cloudflare limit, not editable); **1 GB free storage**
|
||||||
>
|
>
|
||||||
>1. Fork this repository and name it **NodeWarden**.
|
>1. Fork this repository and name it **NodeWarden**.
|
||||||
>2. Open your new repository, go to `Actions`, click `I understand my workflows, go ahead and enable them`, then run `Switch to KV mode`.
|
>2. Open the new repository, go to `Actions`, click `I understand my workflows, go ahead and enable them`, then run `Switch to KV mode`.
|
||||||
>3. After that, **in your own repository**, click the button below. On the page that opens, rename the project to **NodeWarden2** and set **JWT_SECRET** to a random 32-character string.
|
>3. After that, **in your own repository**, click the button below. On the page that opens, rename the project to **NodeWarden2** and set **JWT_SECRET** to a random 32-character string. Do not select `Create dedicated Git repository`.
|
||||||
>
|
>
|
||||||
> [](https://deploy.workers.cloudflare.com/?url=https://github.com/shuaiplus/NodeWarden)
|
> [](https://deploy.workers.cloudflare.com/?url=https://github.com/shuaiplus/NodeWarden)
|
||||||
>
|
>
|
||||||
>4. On the same page, open the Worker settings and disconnect the `Git repository`.
|
>4. On the same page, open Worker settings and disconnect the `Git repository`.
|
||||||
>5. Go back to your forked repository (**NodeWarden**) on GitHub, open `Actions`, and run `Import KV ID from NodeWarden2`.
|
>5. Go back to your forked repository (**NodeWarden**) on GitHub, open `Actions`, and run `Import KV ID from NodeWarden2`.
|
||||||
>6. Return to Cloudflare, reconnect the `Git repository` to your forked repository (**NodeWarden**), and change the `Name` field at the bottom back to **NodeWarden**.
|
>6. Return to Cloudflare, reconnect the `Git repository` to your forked repository (**NodeWarden**), and change the `Name` field at the bottom back to **NodeWarden**.
|
||||||
>7. The GitHub repository **NodeWarden2** can then be deleted.
|
>7. The GitHub repository **NodeWarden2** can then be deleted.
|
||||||
@@ -87,8 +87,8 @@
|
|||||||
|
|
||||||
> [!TIP]
|
> [!TIP]
|
||||||
> Sync upstream (keep your fork updated):
|
> Sync upstream (keep your fork updated):
|
||||||
>- Manual: open your fork on GitHub and click `Sync fork` when prompted. Do not click `Contribute`.
|
>- Manual: open your fork on GitHub, click `Sync fork`, then click `Update branch`.
|
||||||
>- Automatic: in your fork, go to `Actions`, click `I understand my workflows, go ahead and enable them`. Once enabled, `Sync upstream` will automatically sync the upstream `main` branch every day at 3 AM and keep your current [wrangler.toml](./wrangler.toml) configuration unchanged.
|
>- Automatic: in your fork, go to `Actions` -> `Sync upstream` -> `Enable workflow`. It will automatically sync from upstream every day at 3 AM.
|
||||||
|
|
||||||
### CLI deploy
|
### CLI deploy
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user