Skip to content

Commit 10874ae

Browse files
DIYgodDIYgod
authored
docs: reorder deployment guides (#146)
- Reorganize Deploy to xxx sections: Vercel, Zeabur, Heroku, Cloudflare Workers, Fly.io, Railway, Google App Engine, Sealos, PikaPods - Update both English and Chinese documentation
1 parent d26b16e commit 10874ae

2 files changed

Lines changed: 79 additions & 79 deletions

File tree

‎src/deploy/index.md‎

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -394,24 +394,17 @@ sudo ansible-playbook rsshub.yaml
394394
# For example, if your users use https://rsshub.example.com to access your RSSHub instance, enter rsshub.example.com (remove the https://)
395395
```
396396

397-
## Deploy to Railway
398-
399-
Automatic updates are included.
400-
401-
[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/QxW__f?referralCode=9wT3hc)
402-
403-
## Deploy to Heroku
397+
## Deploy to Vercel
404398

405399
### Instant deploy (without automatic update)
406400

407-
[![Deploy to Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https%3A%2F%2Fgithub.com%2FDIYgod%2FRSSHub)
401+
[![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/DIYgod/RSSHub)
408402

409403
### Automatic deploy upon update
410404

411405
1. [Fork RSSHub](https://github.com/DIYgod/RSSHub/fork) to your GitHub account.
412-
2. Deploy your fork to Heroku: `https://heroku.com/deploy?template=URL`, where `URL` is your fork address (_e.g._ `https://github.com/USERNAME/RSSHub`).
413-
3. Configure `automatic deploy` in Heroku app to follow the changes to your fork.
414-
4. Install [Pull](https://github.com/apps/pull) app to keep your fork synchronized with RSSHub.
406+
2. Deploy your fork to Vercel: Login Vercel with your GitHub account, create and deploy [new Vercel project](https://vercel.com/new/) with your RSSHub repository.
407+
3. Install [Pull](https://github.com/apps/pull) app to keep your fork synchronized with RSSHub.
415408

416409
## Deploy to Zeabur
417410

@@ -422,17 +415,33 @@ Automatic updates are included.
422415

423416
[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/templates/X46PTP)
424417

425-
## Deploy to Vercel
418+
## Deploy to Heroku
426419

427420
### Instant deploy (without automatic update)
428421

429-
[![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/DIYgod/RSSHub)
422+
[![Deploy to Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https%3A%2F%2Fgithub.com%2FDIYgod%2FRSSHub)
430423

431424
### Automatic deploy upon update
432425

433426
1. [Fork RSSHub](https://github.com/DIYgod/RSSHub/fork) to your GitHub account.
434-
2. Deploy your fork to Vercel: Login Vercel with your GitHub account, create and deploy [new Vercel project](https://vercel.com/new/) with your RSSHub repository.
435-
3. Install [Pull](https://github.com/apps/pull) app to keep your fork synchronized with RSSHub.
427+
2. Deploy your fork to Heroku: `https://heroku.com/deploy?template=URL`, where `URL` is your fork address (_e.g._ `https://github.com/USERNAME/RSSHub`).
428+
3. Configure `automatic deploy` in Heroku app to follow the changes to your fork.
429+
4. Install [Pull](https://github.com/apps/pull) app to keep your fork synchronized with RSSHub.
430+
431+
## Deploy to Cloudflare Workers
432+
433+
RSSHub can be deployed to Cloudflare Workers with one click.
434+
435+
[![Deploy to Cloudflare](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/DIYgod/RSSHub)
436+
437+
Puppeteer is supported via [Cloudflare Browser Rendering](https://developers.cloudflare.com/browser-rendering/), and caching is supported via [Cloudflare Workers KV](https://developers.cloudflare.com/kv/).
438+
439+
:::warning
440+
441+
- Workers Paid plan is required. Free plan has a 3 MB Worker size limit which is insufficient for RSSHub.
442+
- Browser Rendering (for puppeteer) also requires Workers Paid plan.
443+
444+
:::
436445

437446
## Deploy to Fly.io
438447

@@ -492,32 +501,11 @@ $ fly secrets set CACHE_TYPE=redis REDIS_URL='<the connection URL>'
492501

493502
and execute `fly deploy` (if use the second install method) to trigger a redeployment to complete the configuration.
494503

495-
## Deploy to Sealos(use Redis as cache)
504+
## Deploy to Railway
496505

497506
Automatic updates are included.
498507

499-
[![Deploy to Sealos](https://raw.githubusercontent.com/labring-actions/templates/main/Deploy-on-Sealos.svg)](https://template.cloud.sealos.io/deploy?templateName=rsshub)
500-
501-
## Deploy to PikaPods
502-
503-
Run RSSHub from just $1/month. Includes automatic updates and $5 free starting credit.
504-
505-
[![Run on PikaPods](https://www.pikapods.com/static/run-button.svg)](https://www.pikapods.com/pods?run=rsshub)
506-
507-
## Deploy to Cloudflare Workers
508-
509-
RSSHub can be deployed to Cloudflare Workers with one click.
510-
511-
[![Deploy to Cloudflare](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/DIYgod/RSSHub)
512-
513-
Puppeteer is supported via [Cloudflare Browser Rendering](https://developers.cloudflare.com/browser-rendering/), and caching is supported via [Cloudflare Workers KV](https://developers.cloudflare.com/kv/).
514-
515-
:::warning
516-
517-
- Workers Paid plan is required. Free plan has a 3 MB Worker size limit which is insufficient for RSSHub.
518-
- Browser Rendering (for puppeteer) also requires Workers Paid plan.
519-
520-
:::
508+
[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/QxW__f?referralCode=9wT3hc)
521509

522510
## Deploy to Google App Engine(GAE)
523511

@@ -593,6 +581,18 @@ For changing the deployment project id or version id, please refer to `Deploying
593581
594582
You can access your `Google App Engine URL` to check the deployment status
595583
584+
## Deploy to Sealos(use Redis as cache)
585+
586+
Automatic updates are included.
587+
588+
[![Deploy to Sealos](https://raw.githubusercontent.com/labring-actions/templates/main/Deploy-on-Sealos.svg)](https://template.cloud.sealos.io/deploy?templateName=rsshub)
589+
590+
## Deploy to PikaPods
591+
592+
Run RSSHub from just $1/month. Includes automatic updates and $5 free starting credit.
593+
594+
[![Run on PikaPods](https://www.pikapods.com/static/run-button.svg)](https://www.pikapods.com/pods?run=rsshub)
595+
596596
## Play with Docker
597597
598598
If you would like to test routes or avoid IP limits, etc., you may build your own RSSHub for free by clicking the button below.

‎src/zh/deploy/index.md‎

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -385,24 +385,17 @@ sudo ansible-playbook rsshub.yaml
385385
# 举例：如果您的 RSSHub 用户使用 https://rsshub.example.com 访问您的 RSSHub 实例，输入 rsshub.example.com（去掉 https://）
386386
```
387387

388-
## 部署到 Railway
389-
390-
包含自动更新。
391-
392-
[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/QxW\_\_f?referralCode=9wT3hc)
393-
394-
## 部署到 Heroku
388+
## 部署到 Vercel
395389

396390
### 一键部署（无自动更新）
397391

398-
[![Deploy to Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https%3A%2F%2Fgithub.com%2FDIYgod%2FRSSHub)
392+
[![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/DIYgod/RSSHub)
399393

400394
### 自动更新部署
401395

402-
1. 将 RSSHub [分叉（fork）](https://github.com/DIYgod/RSSHub/fork) 到自己的账户下。
403-
2. 把自己的分叉部署到 Heroku：`https://heroku.com/deploy?template=URL`，其中 `URL` 改为分叉地址 （例如 `https://github.com/USERNAME/RSSHub`）。
404-
3. 检查 Heroku 设置，随代码库更新自动部署。
405-
4. 安装 [Pull](https://github.com/apps/pull) 应用，定期将 RSSHub 改动自动同步至你的分叉。
396+
1. 将 RSSHub [分叉（fork）](https://github.com/DIYgod/RSSHub/fork) 到自己的账户下
397+
2. 去 Vercel 部署一个新项目：使用 GitHub 账户登录 Vercel，进入 [项目创建页面](https://vercel.com/new/) 选择导入 RSSHub 仓库进行部署
398+
3. 安装 [Pull](https://github.com/apps/pull) 应用，定期将 RSSHub 改动自动同步至你的仓库
406399

407400
## 部署到 Zeabur
408401

@@ -413,17 +406,33 @@ sudo ansible-playbook rsshub.yaml
413406

414407
[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/templates/X46PTP)
415408

416-
## 部署到 Vercel
409+
## 部署到 Heroku
417410

418411
### 一键部署（无自动更新）
419412

420-
[![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/DIYgod/RSSHub)
413+
[![Deploy to Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https%3A%2F%2Fgithub.com%2FDIYgod%2FRSSHub)
421414

422415
### 自动更新部署
423416

424-
1. 将 RSSHub [分叉（fork）](https://github.com/DIYgod/RSSHub/fork) 到自己的账户下
425-
2. 去 Vercel 部署一个新项目：使用 GitHub 账户登录 Vercel，进入 [项目创建页面](https://vercel.com/new/) 选择导入 RSSHub 仓库进行部署
426-
3. 安装 [Pull](https://github.com/apps/pull) 应用，定期将 RSSHub 改动自动同步至你的仓库
417+
1. 将 RSSHub [分叉（fork）](https://github.com/DIYgod/RSSHub/fork) 到自己的账户下。
418+
2. 把自己的分叉部署到 Heroku：`https://heroku.com/deploy?template=URL`，其中 `URL` 改为分叉地址 （例如 `https://github.com/USERNAME/RSSHub`）。
419+
3. 检查 Heroku 设置，随代码库更新自动部署。
420+
4. 安装 [Pull](https://github.com/apps/pull) 应用，定期将 RSSHub 改动自动同步至你的分叉。
421+
422+
## 部署到 Cloudflare Workers
423+
424+
RSSHub 支持一键部署到 Cloudflare Workers。
425+
426+
[![Deploy to Cloudflare](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/DIYgod/RSSHub)
427+
428+
通过 [Cloudflare Browser Rendering](https://developers.cloudflare.com/browser-rendering/) 支持 puppeteer，通过 [Cloudflare Workers KV](https://developers.cloudflare.com/kv/) 支持缓存。
429+
430+
:::warning
431+
432+
- 需要 Workers 付费版。免费版的 Worker 大小限制为 3 MB，不足以运行 RSSHub。
433+
- Browser Rendering（用于 puppeteer）同样需要 Workers 付费版。
434+
435+
:::
427436

428437
## 部署到 Fly.io
429438

@@ -488,32 +497,11 @@ $ fly secrets set CACHE_TYPE=redis REDIS_URL='<刚才的连接 URL>'
488497

489498
并执行 `fly deploy` 触发重新部署来完成配置。
490499

491-
## 部署到 Sealos
492-
493-
包含自动更新
494-
495-
[![Deploy to Sealos](https://raw.githubusercontent.com/labring-actions/templates/main/Deploy-on-Sealos.svg)](https://template.cloud.sealos.io/deploy?templateName=rsshub)
496-
497-
## 部署到 PikaPods
498-
499-
每月只需 1 美元即可运行 RSSHub。包括自动更新和 5 美元的免费起始额度。
500-
501-
[![Run on PikaPods](https://www.pikapods.com/static/run-button.svg)](https://www.pikapods.com/pods?run=rsshub)
502-
503-
## 部署到 Cloudflare Workers
504-
505-
RSSHub 支持一键部署到 Cloudflare Workers。
506-
507-
[![Deploy to Cloudflare](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/DIYgod/RSSHub)
508-
509-
通过 [Cloudflare Browser Rendering](https://developers.cloudflare.com/browser-rendering/) 支持 puppeteer，通过 [Cloudflare Workers KV](https://developers.cloudflare.com/kv/) 支持缓存。
510-
511-
:::warning
500+
## 部署到 Railway
512501

513-
- 需要 Workers 付费版。免费版的 Worker 大小限制为 3 MB，不足以运行 RSSHub。
514-
- Browser Rendering（用于 puppeteer）同样需要 Workers 付费版。
502+
包含自动更新。
515503

516-
:::
504+
[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/QxW\_\_f?referralCode=9wT3hc)
517505

518506
## 部署到 Google App Engine
519507

@@ -591,6 +579,18 @@ gcloud app deploy
591579

592580
部署完成后可访问您的 Google App Engine URL 查看部署情况。
593581

582+
## 部署到 Sealos
583+
584+
包含自动更新
585+
586+
[![Deploy to Sealos](https://raw.githubusercontent.com/labring-actions/templates/main/Deploy-on-Sealos.svg)](https://template.cloud.sealos.io/deploy?templateName=rsshub)
587+
588+
## 部署到 PikaPods
589+
590+
每月只需 1 美元即可运行 RSSHub。包括自动更新和 5 美元的免费起始额度。
591+
592+
[![Run on PikaPods](https://www.pikapods.com/static/run-button.svg)](https://www.pikapods.com/pods?run=rsshub)
593+
594594
## Play with Docker
595595

596596
如果想要测试因为反爬规则导致无法访问的路由，您可以点击下方按钮拉起一套免费，临时，专属于您的 RSSHub

0 commit comments

Comments
 (0)