xiaoxue_admin
/
RSSHub
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
RSSHub/website/docs/install/config.md

629 lines
29 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 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](https://www.npmjs.com/package/socks-proxy-agent) NPM package page. See also [cURL OOTW: SOCKS5](https://daniel.haxx.se/blog/2020/05/26/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
:::warning
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:
```js
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](https://www.npmjs.com/package/socks-proxy-agent) NPM package page and [source](https://github.com/TooTallNate/proxy-agents/blob/63adbcefdb4783cc67c0eb90200886b4064e8639/packages/socks-proxy-agent/src/index.ts#L81) for what these protocols mean. See also [cURL OOTW: SOCKS5](https://daniel.haxx.se/blog/2020/05/26/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](#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 Configurations
RSSHub supports access control via access key/code, allowlisting and denylisting, enabling any will activate access control for all routes. `ALLOW_LOCALHOST: true` will grant access to all localhost IP addresses.
### Allowlisting/denylisting
- `ALLOWLIST`: the allowlist. When set, values in `DENYLIST` are disregarded
- `DENYLIST`: the denylist
Allowlisting/denylisting support IP, route and UA as values, fuzzy matching. Use `,` as the delimiter to separate multiple values, eg: `ALLOWLIST=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 allowlist/denylisting.
| | Allowlist | Denylist | Correct access key/code | Wrong access key/code | No access key/code |
| ----------- | ----------- | ----------- | ----------------------- | --------------------- | ------------------ |
| Allowlist | ✅ | ✅ | ✅ | ✅ | ✅ |
| Denylist | ✅ | ❌ | ✅ | ❌ | ❌ |
## 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](https://github.com/winstonjs/winston#logging-levels) 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](https://sentry.io) 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](/parameter#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](https://github.com/DIYgod/RSSHub/issues/2769). You may use any property listed in [URL](https://developer.mozilla.org/en-US/docs/Web/API/URL#Properties) (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](/parameter#multimedia-processing)
`FILTER_REGEX_ENGINE`: Define Regex engine used in [Parameters->filtering](/parameter#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)](https://owasp.org/www-community/attacks/Server_Side_Request_Forgery)
## 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](https://pptr.dev/api/puppeteer.browser.wsendpoint)
`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`
`OPENAI_API_KEY`: OpenAI API Key, used for using ChatGPT to summarize articles
`OPENAI_MODEL`: OpenAI model name, used for using ChatGPT to summarize articles, default to `gpt-3.5-turbo-16k`, see [OpenAI API reference](https://platform.openai.com/docs/models/overview) for details
`OPENAI_TEMPERATURE`: OpenAI temperature parameter, used for using ChatGPT to summarize articles, default to `0.2`, see [OpenAI API reference](https://platform.openai.com/docs/api-reference/chat/create#chat-create-temperature) for details
`OPENAI_MAX_TOKENS`: OpenAI maximum token number, used for using ChatGPT to summarize articles, default to `null`, see [OpenAI API reference](https://platform.openai.com/docs/api-reference/chat/create#chat-create-max_tokens) for details
`OPENAI_API_ENDPOINT`: OpenAI API URL, used for using ChatGPT to summarize articles, default to `https://api.openai.com/v1`, see [OpenAI API reference](https://platform.openai.com/docs/api-reference/chat) for details
`OPENAI_PROMPT`: OpenAI prompt, used for using ChatGPT to summarize articles, see [OpenAI API reference](https://platform.openai.com/docs/api-reference/chat) for details
`REMOTE_CONFIG`: Remote configuration URL, used for dynamically updating configurations. The address should return a JSON with an environment variable name as the key. It will be loaded and merged with local configurations when the application starts. In case of conflicts with local configurations, remote configurations will take precedence. But please note that some basic configuration items do not support remote retrieval.
## Route-specific Configurations {#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](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](https://developer.atlassian.com/cloud/bitbucket/rest/intro/#basic-auth)
- `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://](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](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](https://pastebin.com/YbLCgdWW) 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](https://disqus.com/api/applications/)
- `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
[申请地址](https://gitee.com/api/v5/swagger)
- `GITEE_ACCESS_TOKEN`: Gitee 私人令牌
### GitHub
[Access Token application](https://github.com/settings/tokens)
- `GITHUB_ACCESS_TOKEN`: GitHub Access Token
### Google Fonts
[API key application](https://developers.google.com/fonts/docs/developer_api#a_quick_example)
- `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
### LightNovel.us
- `SECURITY_KEY`: security_key in the token，please remove %22，example `{%22security_key%22:%223cXXXX%22}`,only need 3cXXXX
### 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 `'`,`"`
- Note: socks5h proxy is not supported due to the limit of email lib `ImapFlow`
### Mastodon
For 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
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](https://reader.miniflux.app)
- `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](https://nhentai.net/register/)
- `NHENTAI_USERNAME`: nhentai username or email
- `NHENTAI_PASSWORD`: nhentai password
### Notion
- `NOTION_TOKEN`: Notion Internal Integration Token, Refer to [Notion Official Set Up Flow](https://developers.notion.com/docs/authorization#internal-integration-auth-flow-set-up) to create Token
### pianyuan
[注册地址](https://pianyuan.org)
- `PIANYUAN_COOKIE`: 对应 cookie 中的 `py_loginauth`, 例：PIANYUAN_COOKIE='py_loginauth=xxxxxxxxxx'
### Pixabay
[Documentation](https://pixabay.com/api/docs/)
- `PIXABAY_KEY`: Pixabay API key
### pixiv
[Registration](https://accounts.pixiv.net/signup)
- `PIXIV_REFRESHTOKEN`: Please refer to [this article](https://gist.github.com/ZipFile/c9ebedb224406f4f11845ab700124362) 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](https://developer.spotify.com)
- `SPOTIFY_CLIENT_ID`: Client ID of the application
- `SPOTIFY_CLIENT_SECRET`: Client secret of the application
For user data related routes
- `SPOTIFY_REFRESHTOKEN`: The refresh token of the user from the Spotify application. Check [this gist](https://gist.github.com/outloudvi/d1bbeb5e989db5385384a223a7263744) for detailed information.
### Telegram
[Bot application](https://telegram.org/blog/bot-revolution)
- `TELEGRAM_TOKEN`: Telegram bot token
### Twitter
Given the recent changes in Twitter and its API access a new method for accessing Twitter anonymously was devised. This method involves using temporary guest accounts created when going through the onboarding process with the Android app.
Please see the details in [Nitter - Guest Account Branch Deployment](https://github.com/zedeus/nitter/wiki/Guest-Account-Branch-Deployment) and [zedeus/nitter#983](https://github.com/zedeus/nitter/issues/983).
In addition, we have prepared a Node.js script to help you use proxies to create these tokens in batches. [Please click here](https://github.com/DIYgod/RSSHub/tree/master/scripts/twitter-token/generate.js).
- `TWITTER_OAUTH_TOKEN`: Support multiple keys, split them with `,`
- `TWITTER_OAUTH_TOKEN_SECRET`: Support multiple keys, split them with `,`
### Wordpress
- `WORDPRESS_CDN`: Proxy HTTP image link with HTTPS link. Consider using:
| url | backbone |
| -------------------------------------- | ------------ |
| [https://imageproxy.pimg.tw/resize?url=](https://imageproxy.pimg.tw/resize?url=) | akamai |
| [https://images.weserv.nl/?url=](https://images.weserv.nl/?url=) | cloudflare |
| [https://pic1.xuehuaimg.com/proxy](https://pic1.xuehuaimg.com/proxy) | cloudflare |
| [https://cors.netnr.workers.dev](https://cors.netnr.workers.dev) | cloudflare |
| [https://netnr-proxy.openode.io](https://netnr-proxy.openode.io) | digitalocean |
### YouTube
[API Key application](https://console.developers.google.com/)
- 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](https://gist.github.com/Kurukshetran/5904e8cb2361623498481f4a9a1338aa) 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 值
### 饭否
[申请地址](https://github.com/FanfouAPI/FanFouAPIDoc/wiki/Oauth)
- `FANFOU_CONSUMER_KEY`: 饭否 Consumer Key
- `FANFOU_CONSUMER_SECRET`: 饭否 Consumer Secret
- `FANFOU_USERNAME`: 饭否登录用户名、邮箱、手机号
- `FANFOU_PASSWORD`: 饭否密码
### 和风天气
[申请地址](https://id.qweather.com/#/register?redirect=https%3A%2F%2Fconsole.qweather.com)
- `HEFENG_KEY`:API key
### 南方周末
用于付费全文
- `INFZM_COOKIE`: infzm 账户登陆后的 cookie，目前只需要 `passport_session=...` 即可获取全文
### 轻小说文库
- `WENKU8_COOKIE`: 登陆轻小说文库后的 cookie
### 色花堂
- `SEHUATANG_COOKIE`: 登陆色花堂后的 cookie 值。
### 网易云歌单
用于歌单及听歌排行
- `NCM_COOKIES`: 网易云音乐登陆后的 cookie 值。
### 微博
用于个人时间线路由
[申请地址](https://open.weibo.com/connect)
- `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](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` 值。
Reference in New Issue View Git Blame Copy Permalink