RSSHub/website/docs/install

sidebar
auto

Deployment

RSSHub provides a painless deployment process if you are equipped with basic programming knowledge, you may open an issue if you believe you have encountered a problem not listed here, the community will try to sort it out asap.

The deployment may involve the followings:

1. Command line interface
2. Git
3. Node.js
4. npm or yarn

Deploy for public access may require:

1. Nginx
2. Docker or docker-compose
3. Redis
4. Heroku
5. Google App Engine
6. Fly.io
7. Zeabur

Docker Image

We recommend using the latest version diygod/rsshub (i.e. diygod/rsshub:latest) of the docker image.

When the latest version is unstable, you can use the image with a date tag for temporary use. For example:

$ docker pull diygod/rsshub:2021-06-18

You can back to the latest version when the code has been fixed and rebuild the image.

To enable puppeteer, diygod/rsshub:chromium-bundled is a good choice. If date specified, it will become: diygod/rsshub:chromium-bundled-2021-06-18.

Another approach to enable puppeteer is deploying with Docker Compose. However, it consumes more disk space and memory. By modifying docker-compose.yml, you can use diygod/rsshub:chromium-bundled instead to reduce the disk space and memory consumption.

Docker Compose Deployment

Install

Download docker-compose.yml

$ wget https://raw.githubusercontent.com/DIYgod/RSSHub/master/docker-compose.yml

Check if any configuration needs to be changed

$ vi docker-compose.yml  # or your favorite editor

Create a docker volume to persist Redis caches

$ docker volume create redis-data

Launch

$ docker-compose up -d

Update

Remove old containers

$ docker-compose down

Repull the latest image if you have downloaded the image before. It is helpful to resolve some issues.

$ docker pull diygod/rsshub

Then repeat the installation steps

Configuration

Edit environment in docker-compose.yml

Docker Deployment

:::tip

To enable puppeteer, replace diygod/rsshub with diygod/rsshub:chromium-bundled in EACH command.

:::

Install

Execute the following command to pull RSSHub's docker image.

$ docker pull diygod/rsshub

Start an RSSHub container

$ docker run -d --name rsshub -p 1200:1200 diygod/rsshub

Visit http://127.0.0.1:1200/, and enjoy it! ✅

Execute the following command to stop RSSHub.

$ docker stop rsshub

Update

Remove the old container

$ docker stop rsshub
$ docker rm rsshub

Then repeat the installation steps

Configuration

The simplest way to configure RSSHub container is via system environment variables.

For example, adding -e CACHE_EXPIRE=3600 will set the cache time to 1 hour.

$ docker run -d --name rsshub -p 1200:1200 -e CACHE_EXPIRE=3600 -e GITHUB_ACCESS_TOKEN=example diygod/rsshub

This deployment method does not include puppeteer (unless using diygod/rsshub:chromium-bundled instead) and Redis dependencies. Use the Docker Compose deployment method or deploy external dependencies yourself if you need it.

To configure more options please refer to Configuration.

Ansible Deployment

This Ansible playbook includes RSSHub, Redis, browserless (uses Docker) and Caddy 2

Currently only support Ubuntu 20.04

Requires sudo privilege and virtualization capability (Docker will be automatically installed)

Install

sudo apt update
sudo apt install ansible
git clone https://github.com/DIYgod/RSSHub.git ~/RSSHub
cd ~/RSSHub/scripts/ansible
sudo ansible-playbook rsshub.yaml
# When prompt to enter a domain name, enter the domain name that this machine/VM will use
# For example, if your users use https://rsshub.example.com to access your RSSHub instance, enter rsshub.example.com (remove the https://)

Update

cd ~/RSSHub/scripts/ansible
sudo ansible-playbook rsshub.yaml
# When prompt to enter a domain name, enter the domain name that this machine/VM will use
# For example, if your users use https://rsshub.example.com to access your RSSHub instance, enter rsshub.example.com (remove the https://)

Manual Deployment

The most direct way to deploy RSSHub, you can follow the steps below to deployRSSHub on your computer, server or anywhere.

Install

Execute the following commands to download the source code

$ git clone https://github.com/DIYgod/RSSHub.git
$ cd RSSHub

Execute the following commands to install dependencies (Do not add the --production parameter for development).

pnpm install --prod

yarn --production

npm install --omit=dev

Launch

Under RSSHub's root directory, execute the following commands to launch

pnpm start

$ yarn start

$ npm start

Or use PM2

$ pm2 start lib/index.js --name rsshub

Visit http://127.0.0.1:1200/, and enjoy it! ✅

Refer to our Guide for usage. Replace https://rsshub.app/ with http://localhost:1200 in any route example to see the effect.

Configuration

:::tip

On arm/arm64, this deployment method does not include puppeteer dependencies. To enable puppeteer, install Chromium from your distribution repositories first, then set CHROMIUM_EXECUTABLE_PATH to its executable path.

Debian:

$ apt install chromium
$ echo >> .env
$ echo 'CHROMIUM_EXECUTABLE_PATH=chromium' >> .env

Ubuntu/Raspbian:

$ apt install chromium-browser
$ echo >> .env
$ echo 'CHROMIUM_EXECUTABLE_PATH=chromium-browser' >> .env

:::

RSSHub can be configured by setting environment variables.

Create a .env file in the root directory of your project. Add environment-specific variables on new lines in the form of NAME=VALUE. For example:

CACHE_TYPE=redis
CACHE_EXPIRE=600

Please notice that it will not override already existed environment variables, more rules please refer to dotenv

This deployment method does not include Redis dependencies. Use the Docker Compose deployment method or deploy external dependencies yourself if you need it.

To configure more options please refer to Configuration.

Update

Under RSSHub's directory, execute the following commands to pull the latest source code for RSSHub

$ git pull

Then repeat the installation steps.

A tip for Nix users

To install nodejs, yarn and jieba (to build documentation) you can use the following nix-shell configuration script.

let
    pkgs = import <nixpkgs> {};
    node = pkgs.nodejs-12_x;
in pkgs.stdenv.mkDerivation {
    name = "nodejs-yarn-jieba";
    buildInputs = [node pkgs.yarn pkgs.pythonPackages.jieba];
}

Deploy to Railway

Automatic updates are included.

Deploy to Heroku

Notice

:::caution Update

Heroku no longer offers free product plans.

:::

Heroku accounts with unverified payment methods have only 550 hours of credit per month (about 23 days), and up to 1,000 hours per month with verified payment methods.

Instant deploy (without automatic update)

Automatic deploy upon update

1. Fork RSSHub to your GitHub account.
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).
3. Configure automatic deploy in Heroku app to follow the changes to your fork.
4. Install Pull app to keep your fork synchronized with RSSHub.

Deploy to Vercel (ZEIT Now)

Instant deploy (without automatic update)

Automatic deploy upon update

1. Fork RSSHub to your GitHub account.
2. Deploy your fork to Vercel: Login Vercel with your GitHub account, create and deploy new Vercel project with your RSSHub repository.
3. Install Pull app to keep your fork synchronized with RSSHub.

Deploy to Fly.io

Method 1: Fork

1. Fork RSSHub to your GitHub account;

2. Clone the source code from your fork

   $ git clone https://github.com/<your username>/RSSHub.git
   $ cd RSSHub
   

3. Sign up for Fly.io and install the flyctl CLI;

4. Run fly launch and choose a unique name and region to deploy;

5. Use fly secrets set KEY=VALUE to configure some modules;

6. Set up automatic deployment via GitHub Actions;

7. (Optional) Use fly certs add your domain to configure a custom domain, and follow the instructions to configure the related domain resolution at your DNS service provider (you can check the domain configuration status on the Dashboard Certificate page).

Upgrade: On the homepage of your Forked repository, click "Sync fork - Update Branch" to manually update to the latest official master branch, or install the Pull GitHub app to keep your fork synchronized with upstream.

Method 2: Maintain fly.toml by yourself

1. Sign up for Fly.io and install the flyctl CLI;
2. Create a new empty directory locally, run fly launch in it, and choose a unique name and instance region;
3. Edit the generated fly.toml file, add

[build]
image = "diygod/rsshub:latest"

Depending on the actual situation, you may want to use other image tags, please read the relevant content of Docker Image; 4. Modify the [env] section in fly.toml or use fly secrets set KEY=VALUE to configure some modules; 5. Execute fly deploy to start the application; 6. (Optional) Use fly certs add your domain to configure a custom domain, and follow the instructions to configure the related domain resolution at your DNS service provider (you can check the domain configuration status on the Dashboard Certificate page).

Upgrade: Enter the directory where you saved the fly.toml file and execute fly deploy to trigger the steps of pulling the latest image and starting the upgraded application.

Configure built-in Upstash Redis as cache

Run in the RSSHub folder

$ flyctl redis create

to create a new Redis database. Choose the same region as when you created the RSSHub app above, and it is recommended to enable eviction. After creation, a string in the form of redis://default:<password>@<domain>.upstash.io will be printed.

Due to a bug in a dependency, you currently need to append the family=6 parameter to the URL provided by Fly.io, i.e., use redis://default:<password>@<domain>.upstash.io/?family=6 as the connection URL.

Then configure the [env] section in fly.toml or run

$ fly secrets set CACHE_TYPE=redis REDIS_URL='<the connection URL>'

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

Deploy to PikaPods

Run RSSHub from just $1/month. Includes automatic updates and $5 free starting credit.

Deploy to Zeabur

1. Sign up for Zeabur
2. Create a new project.
3. Create a new service in the project, select deploying from the marketplace.
4. Add a domain name, if you use a custom domain name, you can refer to Zeabur's domain name binding document.

Deploy to Google App Engine(GAE)

Before You Begin

Follow the official guide for completing your GCP account settings, creating a new Node project, adding billing information (required), installing git and initializing gcloud(link). Node.js is not required if you don't plan to debug RSSHub locally.

Please note, GAE free tier doesn't support Flexible Environment, please check the pricing plan prior to deployment.

Node.js standard environment is still under beta, unknown or unexpected errors might be encountered during the deployment.

Execute git clone https://github.com/DIYgod/RSSHub.git to pull the latest code

app.yaml Settings

Deploy to Flexible Environment

Under RSSHub's root directory, create a file app.yaml with the following content:

# [START app_yaml]
runtime: custom
env: flex

# This sample incurs costs to run on the App Engine flexible environment.
# The settings below are to reduce costs during testing and are not appropriate
# for production use. For more information, see:
# https://cloud.google.com/appengine/docs/flexible/nodejs/configuring-your-app-with-app-yaml
manual_scaling:
    instances: 1
# app engine resources, adjust to suit your needs, the required disk space is 10 GB
resources:
    cpu: 1
    memory_gb: 0.5
    disk_size_gb: 10
network:
    forwarded_ports:
        - 80:1200
        - 443:1200
# environment variables section, refer to Settings
env_variables:
    CACHE_EXPIRE: '300'
# [END app_yaml]

Deploy to standard environment

Under RSSHub's root directory, create a file app.yaml with the following content:

# [START app_yaml]
runtime: nodejs8

network:
    forwarded_ports:
        - 80:1200
        - 443:1200
# environment variables section, refer to Settings
env_variables:
    CACHE_EXPIRE: '300'
# [END app_yaml]

Install

Under RSSHub's root directory, execute the following commands to launch RSSHub

gcloud app deploy

For changing the deployment project id or version id, please refer to Deploying a service section here.

You can access your Google App Engine URL to check the deployment status

Play with Docker

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.

:::caution

• DockerHub account required
• Play with Docker instance will last for 4 hours at most. It should only be used for testing purpose
• If deploy success but port cannot be auto-deteced，please click the open port button on the top and type 1200
• Sometimes PWD won't work as expected. If you encounter blank screen after Start, or some error during initialization, please retry

:::

Configuration

Configure RSSHub by setting environment variables

Network Configuration

PORT: listening port, default to 1200

SOCKET: listening Unix Socket, default to null

LISTEN_INADDR_ANY: open up for external access, default to 1

REQUEST_RETRY: retries allowed for failed requests, default to 2

REQUEST_TIMEOUT: milliseconds to wait for the server to end the response before aborting the request with error, default to 3000

UA: user agent, using random user agent (Chrome on macOS) by default

NO_RANDOM_UA: disable random user agent, default to null

CORS Request

RSSHub by default reject CORS requests. This behavior can be modified via setting ALLOW_ORIGIN: * or ALLOW_ORIGIN: www.example.com.

Cache Configurations

RSSHub supports two caching methods: memory and redis

CACHE_TYPE: cache type, memory or redis, empty this value will disable caching, default to memory

CACHE_EXPIRE: route cache expiry time in seconds, default to 5 * 60

CACHE_CONTENT_EXPIRE: content cache expiry time in seconds, it will be recalculated when it is accessed, default to 1 * 60 * 60

REDIS_URL: Redis target address (invalid when CACHE_TYPE is set to memory), default to redis://localhost:6379/

MEMORY_MAX: maximum number of cached items (invalid when CACHE_TYPE is set to redis), default to 256

Proxy Configurations

Partial routes have a strict anti-crawler policy, and can be configured to use proxy.

Proxy can be configured through Proxy URI, Proxy options, or Reverse proxy.

Proxy URI

PROXY_URI: Proxy supports socks4, socks5(hostname is resolved locally, not recommanded), socks5h(hostname is resolved by the SOCKS server, recommanded, prevents DNS poisoning or DNS leak), http, https. See socks-proxy-agent NPM package page. See also cURL OOTW: SOCKS5.

Proxy URI's format:

• {protocol}://{host}:{port}
• {protocol}://{username}:{password}@{host}:{port} (with credentials)

Some examples:

• socks4://127.0.0.1:1080
• socks5h://user:pass@127.0.0.1:1080 (username as user, password as pass)
• socks://127.0.0.1:1080 (socks5h when protocol is socks)
• http://127.0.0.1:8080
• http://user:pass@127.0.0.1:8080
• https://127.0.0.1:8443

Reverse proxy

:::caution

This proxy method cannot proxy requests that contain cookies.

:::

REVERSE_PROXY_URL: Reverse proxy URL, RSSHub will use this URL as a prefix to initiate requests, for example https://proxy.example.com?target=, requests to https://google.com will be automatically converted to https://proxy.example.com?target=https%3A%2F%2Fgoogle.com

You can use Cloudflare Workers to build a simple reverse proxy, for example:

addEventListener('fetch', event => {
  event.respondWith(handleRequest(event.request))
})

async function handleRequest(request) {
  const url = new URL(request.url)
  let target = url.searchParams.get('target')

  if (!target) {
    return new Response('Hello, this is Cloudflare Proxy Service. To proxy your requests, please use the "target" URL parameter.')
  } else {
    target = decodeURIComponent(target)
    const newRequest = new Request(target, {
      headers: request.headers,
      method: request.method,
      body: request.body
    })
    return await fetch(newRequest)
  }
}

Proxy options

PROXY_PROTOCOL: Using proxy, supports socks, http, https, etc. See socks-proxy-agent NPM package page and source for what these protocols mean. See also cURL OOTW: SOCKS5 for reference.

PROXY_HOST: host or IP of the proxy

PROXY_PORT: port of the proxy

PROXY_AUTH: credentials to authenticate a user agent to proxy server, Proxy-Authorization: Basic ${process.env.PROXY_AUTH}

PROXY_URL_REGEX: regex for url of enabling proxy, default to .*

User Authentication Configurations

Routes in protected_route.js will be protected using HTTP Basic Authentication.

When adding feeds using RSS readers with HTTP Basic Authentication support, authentication information is required, eg: https://usernam3:passw0rd@rsshub.app/protected/rsshub/routes.

For readers that do not support HTTP Basic authentication, please refer to Access Control Configuration.

HTTP_BASIC_AUTH_NAME: HTTP basic authentication username, default to usernam3, please change asap

HTTP_BASIC_AUTH_PASS: HTTP basic authentication password, default to passw0rd, please change asap

Access Control Configuration

RSSHub supports access control via access key/code, whitelisting and blacklisting, enabling any will activate access control for all routes. ALLOW_LOCALHOST: true will grant access to all localhost IP addresses.

White/blacklisting

• WHITELIST: the blacklist. When set, values in BLACKLIST are disregarded

• BLACKLIST: the blacklist

White/blacklisting support IP, route and UA as values, fuzzy matching. Use , as the delimiter to separate multiple values, eg: WHITELIST=1.1.1.1,2.2.2.2,/qdaily/column/59

Access Key/Code

• ACCESS_KEY: the access key. When set, access via the key directly or the access code described above

Access code is the md5 generated based on the access key + route, eg:

Access key	Route	Generating access code	Access code
ILoveRSSHub	/qdaily/column/59	md5('/qdaily/column/59' + 'ILoveRSSHub')	0f820530128805ffc10351f22b5fd121

• Routes are accessible via code, eg: https://rsshub.app/qdaily/column/59?code=0f820530128805ffc10351f22b5fd121

• Or using key directly, eg: https://rsshub.app/qdaily/column/59?key=ILoveRSSHub

See the relation between access key/code and white/blacklisting.

	Whitelisted	Blacklisted	Correct access key/code	Wrong access key/code	No access key/code
Whitelisted	✅	✅	✅	✅	✅
Blacklisted	✅	❌	✅	❌	❌

Logging Configurations

DEBUG_INFO: display route information on the homepage for debugging purposes. When set to neither true nor false, use parameter debug to enable display, eg: https://rsshub.app/?debug=value_of_DEBUG_INFO . Default to true

LOGGER_LEVEL: specifies the maximum level of messages to the console and log file, default to info

NO_LOGFILES: disable logging to log files, default to false

SHOW_LOGGER_TIMESTAMP: Show timestamp in log, default to false

SENTRY: Sentry dsn, used for error tracking

SENTRY_ROUTE_TIMEOUT: Report Sentry if route execution takes more than this milliseconds, default to 3000

Image Processing

:::tip New Config Format

We are currently testing out a new format, providing end-user with more flexibility. For more info, please refer to Parameters->Multimedia processing.

When using our new config, please leave the following environment vairable blank. By default, image hotlink template will be forced when present.

:::

HOTLINK_TEMPLATE: replace image URL in the description to avoid anti-hotlink protection, leave it blank to disable this function. Usage reference #2769. You may use any property listed in URL (suffixing with _ue results in URL encoding), format of JS template literal. e.g. ${protocol}//${host}${pathname}, https://i3.wp.com/${host}${pathname}, https://images.weserv.nl?url=${href_ue}

HOTLINK_INCLUDE_PATHS: limit the routes to be processed, only matched routes will be processed. Set multiple values with comma , as delimiter. If not set, all routes will be processed

HOTLINK_EXCLUDE_PATHS: exclude routes that do not need to be processed, all matched routes will be ignored. Set multiple values with comma , as delimiter. Can be used alone, or to exclude routes that are already included by HOTLINK_INCLUDE_PATHS. If not set, no routes will be ignored

:::tip Route matching pattern

HOTLINK_INCLUDE_PATHS and HOTLINK_EXCLUDE_PATHS match the root path and all recursive sub-paths of the route, but not substrings. Note that the path must start with / and end without /.

e.g. /example, /example/sub and /example/anthoer/sub/route will be matched by /example, but /example_route will not be matched.

It is also valid to contain route parameters, e.g. /weibo/user/2612249974.

:::

Features

:::tip Experimental features

Configs in this sections are in beta stage, and are turn off by default. Please read corresponded description and turn on if necessary.

:::

ALLOW_USER_HOTLINK_TEMPLATE: Parameters->Multimedia processing

FILTER_REGEX_ENGINE: Define Regex engine used in Parameters->filtering. Valid value are [re2, regexp]. Default value is re2. We suggest public instance should leave this value to default, and this option right now is mainly for backward compatibility.

ALLOW_USER_SUPPLY_UNSAFE_DOMAIN: allow users to provide a domain as a parameter to routes that are not in their allow list, respectively. Public instances are suggested to leave this value default, as it may lead to Server-Side Request Forgery (SSRF)

Other Application Configurations

DISALLOW_ROBOT: prevent indexing by search engine, default to enable, set false or 0 to disable

ENABLE_CLUSTER: enable cluster mode, default to false

NODE_ENV: display error message on pages for authentication failing, default to production (i.e. no display)

NODE_NAME: node name, used for load balancing, identify the current node

PUPPETEER_WS_ENDPOINT: browser WebSocket endpoint which can be used as an argument to puppeteer.connect, refer to browserWSEndpoint

CHROMIUM_EXECUTABLE_PATH: path to the Chromium (or Chrome) executable. If puppeteer is not bundled with Chromium (manually skipped downloading or system architecture is arm/arm64), configuring this can effectively enable puppeteer. Or alternatively, if you prefer Chrome to Chromium, this configuration will help. WARNING: only effective when PUPPETEER_WS_ENDPOINT is not set; only useful for manual deployment, for Docker, please use the chromium-bundled image instead.

TITLE_LENGTH_LIMIT: limit the length of feed title generated in bytes, an English alphabet counts as 1 byte, the rest such as Chinese, Japanese, Korean or Arabic counts as 2 bytes by design, default to 150

Route-specific Configurations

:::tip

Configs here are incomplete.

See docs of the specified route and lib/config.js for detailed information.

:::

• 4399 论坛

  • GAME_4399: 对应登录后的 cookie 值，获取方式：
    1. 在 4399 首页登录。
    2. 打开开发者工具，切换到 Network 面板，刷新
    3. 查找www.4399.com的访问请求，点击请求，在右侧 Headers 中找到 Cookie.

• bilibili 用户关注动态系列路由

  • BILIBILI_COOKIE_{uid}: 对应 uid 的 b 站用户登录后的 Cookie 值，{uid} 替换为 uid，如 BILIBILI_COOKIE_2267573，获取方式：
    1. 打开 https://api.vc.bilibili.com/dynamic_svr/v1/dynamic_svr/dynamic_new?uid=0&type=8
    2. 打开控制台，切换到 Network 面板，刷新
    3. 点击 dynamic_new 请求，找到 Cookie
    4. 视频和专栏，UP 主粉丝及关注只要求 SESSDATA 字段，动态需复制整段 Cookie

• Bitbucket: Basic auth with App passwords

  • BITBUCKET_USERNAME: Your Bitbucket username
  • BITBUCKET_PASSWORD: Your Bitbucket app password

• BTBYR

  • BTBYR_HOST: 支持 ipv4 访问的 BTBYR 镜像，默认为原站 https://bt.byr.cn/。
  • BTBYR_COOKIE: 注册用户登录后的 Cookie 值，获取方式：
    1. 登录后打开网站首页
    2. 打开控制台，刷新
    3. 找到 https://bt.byr.cn/index.php 请求
    4. 找到请求头中的 Cookie

• BUPT

  • BUPT_PORTAL_COOKIE: 登录后获得的 Cookie 值，获取方式
    1. 打开https://webapp.bupt.edu.cn/wap/login.html?redirect=https://并登录
    2. 无视掉报错，并打开 https://webapp.bupt.edu.cn/extensions/wap/news/list.html?p-1&type=xnxw
    3. 打开控制台，刷新
    4. 找到 https://webapp.bupt.edu.cn/extensions/wap/news/list.html?p-1&type=xnxw 请求
    5. 找到请求头中的 Cookie

• Civitai

  • CIVITAI_COOKIE: Cookie of Civitai

• Discord

  • DISCORD_AUTHORIZATION: Discord authorization token, can be found in the header of XHR requests after logging in Discord web client

• Discourse

  • DISCOURSE_CONFIG_{id}: id could be arbitrary number or string, while the value should be the format of {"link":link,"key":key}, where:
    • link is the link to the forum.
    • key is the access key for the forum API, which you can refer to this snippet to obtain one. Ensure that this key is granted sufficient permission.

• Discuz cookie

  • DISCUZ_COOKIE_{cid}: Cookie of a forum powered by Discuz, cid can be anything from 00 to 99. When visiting a Discuz route, use cid to specify this cookie.

• Disqus: API Key application

  • DISQUS_API_KEY: Disqus API

• douban

  • DOUBAN_COOKIE: Cookie of douban user

• E-Hentai

  • EH_IPB_MEMBER_ID: The value of ipb_member_id in the cookie header after logging in E-Hentai
  • EH_IPB_PASS_HASH: The value of ipb_pass_hash in the cookie header after logging in E-Hentai
  • EH_SK: The value of sk in the cookie header after logging in E-Hentai
  • EH_STAR: The value of star in the cookie header if your account has stars. If this value is set, image limit allocation will links to the account rather than IP address
  • EH_IGNEOUS: The value of igneous in the cookie header after logging in ExHentai. If this value is set, RSS will be generated from ExHentai
  • EH_IMG_PROXY: Cover proxy address. If this is set, the link to the cover image will be replaced with this value at the beginning. When using ExHentai, the cover image requires cookies to access it, so you can use this with a cookie-added proxy server to access the cover image without cookies in some readers.

• Fantia

  • FANTIA_COOKIE: The cookie after login can be obtained by viewing the request header in the console, If not filled in will cause some posts that require login to read to get exceptions

• Gitee 全部路由：申请地址

  • GITEE_ACCESS_TOKEN: Gitee 私人令牌

• GitHub: Access Token application

  • GITHUB_ACCESS_TOKEN: GitHub Access Token

• Google Fonts: API key application

  • GOOGLE_FONTS_API_KEY: API key

• Instagram:

  • IG_USERNAME: Your Instagram username (Private API only)
  • IG_PASSWORD: Your Instagram password (Private API only)
  • IG_PROXY: Proxy URL for Instagram (Private API only, optional)
  • IG_COOKIE: Your Instagram cookie (Cookie only)

  Warning: Two Factor Authentication is not supported.

• Iwara:

  • IWARA_USERNAME: username of Iwara User
  • IWARA_PASSWORD: password of Iwara User

• Last.fm

  • LASTFM_API_KEY: Last.fm API Key

• Email:

  • EMAIL_CONFIG_{email}: Mail setting, replace {email} with the email account, replace @ and . in email account with _, e.g. EMAIL_CONFIG_xxx_gmail_com. The value is in the format of password=password&host=server&port=port, eg:
    • Linux env: EMAIL_CONFIG_xxx_qq_com="password=123456&host=imap.qq.com&port=993"
    • docker env: EMAIL_CONFIG_xxx_qq_com=password=123456&host=imap.qq.com&port=993, please do not include quotations ',"

• Mastodon user timeline: apply API here https://mastodon.example/settings/applications(repalce mastodon.example), please check scope read:search

  • MASTODON_API_HOST: API instance domain, only domain, no http:// or https:// protocol header
  • MASTODON_API_ACCESS_TOKEN: user access token
  • MASTODON_API_ACCT_DOMAIN: acct domain for particular instance, Webfinger account URI, like user@host

• Medium related routes: Open the console, copy the cookie (in theory, only uid and sid are required)

  • MEDIUM_ARTICLE_COOKIE: Cookie used when requesting the full article, can access the full text of paid content when there is an active Member subscription.
  • MEDIUM_COOKIE_{username}: Cookie of the user corresponding to the username, required for personalized recommendation related routes.

• MiniFlux:

  • MINIFLUX_INSTANCE: The instance used by the user, by default, is the official MiniFlux paid service address
  • MINIFLUX_TOKEN: User's API key, please log in to the instance used and go to Settings -> API Key -> Create a new API key to obtain.

• nhentai torrent: Registration

  • NHENTAI_USERNAME: nhentai username or email
  • NHENTAI_PASSWORD: nhentai password

• Notion

  • NOTION_TOKEN: Notion Internal Integration Token, Refer to Notion Official Set Up Flow to create Token

• pianyuan 全部路由：注册地址

  • PIANYUAN_COOKIE: 对应 cookie 中的 py_loginauth, 例: PIANYUAN_COOKIE='py_loginauth=xxxxxxxxxx'

• Pixabay: Documentation

  • PIXABAY_KEY: Pixabay API key

• pixiv: Registration

  • PIXIV_REFRESHTOKEN: Please refer to this article to get a refresh_token
  • PIXIV_BYPASS_CDN: bypass Cloudflare bot check by directly accessing Pixiv source server, defaults to disable, set true or 1 to enable
  • PIXIV_BYPASS_HOSTNAME: Pixiv source server hostname or IP address, hostname will be resolved to IPv4 address via PIXIV_BYPASS_DOH, defaults to public-api.secure.pixiv.net
  • PIXIV_BYPASS_DOH: DNS over HTTPS endpoint, it must be compatible with Cloudflare or Google DoH JSON schema, defaults to https://1.1.1.1/dns-query
  • PIXIV_IMG_PROXY: Used as a proxy for image addresses, as pixiv images have anti-theft, default to https://i.pixiv.re

• pixiv fanbox: Get paid content

  • FANBOX_SESSION_ID: equals to FANBOXSESSID in site cookies.

• Saraba1st 用于获取帖子里的图片

  • SARABA1ST_COOKIE: 对应网页端的 Cookie。

• Sci-hub for scientific journal routes:

  • SCIHUB_HOST: The Sci-hub mirror address that is accessible from your location, default to https://sci-hub.se.

• Spotify: API key registration

  • SPOTIFY_CLIENT_ID: Client ID of the application
  • SPOTIFY_CLIENT_SECRET: Client secret of the application

• Spotify (user data related routes):

  • SPOTIFY_REFRESHTOKEN: The refresh token of the user from the Spotify application. Check this gist for detailed information.

• Telegram: Bot application

  • TELEGRAM_TOKEN: Telegram bot token

• Twitter: Application creation

  • TWITTER_CONSUMER_KEY: Twitter Developer API key, support multiple keys, split them with ,
  • TWITTER_CONSUMER_SECRET: Twitter Developer API key secret, support multiple keys, split them with ,
  • TWITTER_WEBAPI_AUTHORIZAION: Twitter Web API authorization, in format key:secret or Bearer ****, support multiple ones, split them with ,. If either of the above environment variables is not set, the Twitter Web API will be used. However, no need to set this environment var since currently known tokens have already been built into RSSHub.
  • TWITTER_TOKEN_{handler}: The token generated by the corresponding Twitter handler, replace {handler} with the Twitter handler, the value is a combination of Twitter API key, Twitter API key secret, Access token, Access token secret connected by a comma ,. Eg. TWITTER_TOKEN_RSSHub=bX1zry5nG4d1RbESQbnADpVIo,2YrD8qo9sXbB8VlYfVmo1Qtw0xsexnOliU5oZofq7aPIGou0Xx,123456789-hlkUHFYmeXrRcf6SEQciP8rP4lzmRgMgwdqIN9aK,pHcPnfa28rCIKhSICUCiaw9ppuSSl7T2f3dnGYpSM0bod.

• Wordpress:

  • WORDPRESS_CDN: Proxy HTTP image link with HTTPS link. Consider using:

    url	backbone
    https://imageproxy.pimg.tw/resize?url=	akamai
    https://images.weserv.nl/?url=	cloudflare
    https://pic1.xuehuaimg.com/proxy/	cloudflare
    https://cors.netnr.workers.dev/	cloudflare
    https://netnr-proxy.openode.io/	digitalocean

• YouTube: API Key application

  • All routes:
    • YOUTUBE_KEY: YouTube API Key, support multiple keys, split them with ,
  • Extra requirements for subscriptions route:
    • YOUTUBE_CLIENT_ID: YouTube API OAuth 2.0 client ID
    • YOUTUBE_CLIENT_SECRET: YouTube API OAuth 2.0 client secret
    • YOUTUBE_REFRESH_TOKEN: YouTube API OAuth 2.0 refresh token. Check this gist for detailed instructions.

• ZodGame:

  • ZODGAME_COOKIE: Cookie of ZodGame User

• 北大未名 BBS 全站十大

  • PKUBBS_COOKIE: BBS 注册用户登录后的 Cookie 值，获取方式：
    1. 登录后打开论坛首页
    2. 打开控制台， 刷新
    3. 找到 https://bbs.pku.edu.cn/v2/home.php 请求
    4. 找到请求头中的 Cookie

• 吹牛部落 栏目更新

  • CHUINIU_MEMBER: 吹牛部落登录后的 x-member，获取方式
    1. 登陆后点开文章正文
    2. 打开控制台，刷新
    3. 找到 http://api.duanshu.com/h5/content/detail/ 开头的请求
    4. 找到请求头中的 x-member

• 滴答清单

  • DIDA365_USERNAME: 滴答清单用户名
  • DIDA365_PASSWORD: 滴答清单密码

• 端传媒设置，用于获取付费内容全文：

  • INITIUM_BEARER_TOKEN: 端传媒 Web 版认证 token。获取方式：登陆后打开端传媒站内任意页面，打开浏览器开发者工具中 “网络”(Network) 选项卡，筛选 URL 找到任一个地址为api.initium.com开头的请求，点击检查其 “消息头”，在 “请求头” 中找到Authorization字段，将其值复制填入配置即可。你的配置应该形如INITIUM_BEARER_TOKEN: 'Bearer eyJxxxx......xx_U8'。使用 token 部署的好处是避免占据登陆设备数的额度，但这个 token 一般有效期为两周，因此只可作临时测试使用。

  • INITIUM_IAP_RECEIPT: 端传媒 iOS 版内购回执认证 token。获取方式：登陆后打开端传媒 iOS app 内任意页面，打开抓包工具，筛选 URL 找到任一个地址为api.initium.com开头的请求，点击检查其 “消息头”，在 “请求头” 中找到X-IAP-Receipt字段，将其值复制填入配置即可。你的配置应该形如INITIUM_IAP_RECEIPT: 'ef81dee9e4e2fe084a0af1ea82da2f7b16e75f756db321618a119fa62b52550e'。

  Web 版认证 token 和 iOS 内购回执认证 token 只需选择其一填入即可。你也可选择直接在环境设置中填写明文的用户名和密码：

  • INITIUM_USERNAME: 端传媒用户名 （邮箱）
  • INITIUM_PASSWORD: 端传媒密码

• 豆瓣想看

  • DOUBAN_COOKIE: 豆瓣登陆后的 Cookie 值

• 饭否 全部路由：申请地址

  • FANFOU_CONSUMER_KEY: 饭否 Consumer Key
  • FANFOU_CONSUMER_SECRET: 饭否 Consumer Secret
  • FANFOU_USERNAME: 饭否登录用户名、邮箱、手机号
  • FANFOU_PASSWORD: 饭否密码

• 和风天气：申请地址

  • HEFENG_KEY:API key

• 南方周末付费全文

  • INFZM_COOKIE: infzm 账户登陆后的 cookie，目前只需要 passport_session=... 即可获取全文

• 轻小说文库

  • WENKU8_COOKIE: 登陆轻小说文库后的 cookie

• 色花堂

  • SEHUATANG_COOKIE: 登陆色花堂后的 cookie 值。

• 网易云歌单及听歌排行

  • NCM_COOKIES: 网易云音乐登陆后的 cookie 值.

• 微博 个人时间线路由：申请地址

  • WEIBO_APP_KEY: 微博 App Key
  • WEIBO_APP_SECRET: 微博 App Secret
  • WEIBO_REDIRECT_URL: 微博登录授权回调地址，默认为 RSSHub 地址/weibo/timeline/0，自定义回调地址请确保最后可以转跳到 RSSHub 地址/weibo/timeline/0?code=xxx

• 微博 自定义分组

  • WEIBO_COOKIES: 用户访问网页微博时所使用的 cookie, 获取方式:
    1. 打开并登录 https://m.weibo.cn (确保打开页面为手机版，如果强制跳转电脑端可尝试使用可更改 UserAgent 的浏览器插件)
    2. 按下F12打开控制台，切换至Network(网络)面板
    3. 在该网页切换至任意关注分组，并在面板打开最先捕获到的请求 (该情形下捕获到的请求路径应包含/feed/group)
    4. 查看该请求的Headers(请求头), 找到Cookie字段并复制内容

• 小宇宙：需要 App 登陆后抓包获取相应数据。

  • XIAOYUZHOU_ID: 即数据包中的 x-jike-device-id。
  • XIAOYUZHOU_TOKEN: 即数据包中的 x-jike-refresh-token。

• 新榜

  • NEWRANK_COOKIE: 登陆后的 COOKIE 值，其中 token 是必要的，其他可删除

• 喜马拉雅

  • XIMALAYA_TOKEN: 对应 cookie 中的 1&_token，获取方式：
    1. 登陆喜马拉雅网页版
    2. 打开控制台，刷新
    3. 查找名称为1&_token的cookie，其内容即为XIMALAYA_TOKEN的值（即在cookie 中查找 1&_token=***;，并设置 XIMALAYA_TOKEN = ***）

• 知乎用户关注时间线

  • ZHIHU_COOKIES: 知乎登录后的 cookie 值.
    1. 可以在知乎网页版的一些请求的请求头中找到，如 GET /moments 请求头中的 cookie 值.