Skip to content

Commit

Permalink
Merge branch 'DIYgod:master' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
xdu authored Jul 11, 2023
2 parents 2b92c9e + f4ec715 commit 47d1423
Show file tree
Hide file tree
Showing 130 changed files with 2,349 additions and 852 deletions.
6 changes: 3 additions & 3 deletions docs/en/install/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -769,9 +769,9 @@ See docs of the specified route and `lib/config.js` for detailed information.
- 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
- `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
- `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)
Expand Down Expand Up @@ -823,7 +823,7 @@ See docs of the specified route and `lib/config.js` for detailed information.
- `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. 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 every single user and guest share the same authorization token which has already been built into RSSHub.
- `TWITTER_WEBAPI_AUTHORIZAION`: Twitter Web API authorization, in format `key:secret`, 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:
Expand Down
8 changes: 7 additions & 1 deletion docs/en/program-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,13 @@ Please use <https://github.com/logseq/logseq/releases.atom> instead.

### APP Update

<RouteEn author="HXHL" example="/macked/app/cleanmymac-x" path="/macked/app/:name" :paramsDesc="['app name, can be find in URL']"/>
<RouteEn author="HXHL" example="/macked/app/cleanmymac-x" path="/macked/app/:name" :paramsDesc="['app name, can be found in URL']"/>

## MacUpdate

### Update

<RouteEn author="TonyRL" example="/macupdate/app/11942" path="/macupdate/app/:appId/:appSlug?" :paramsDesc="['Application unique ID, can be found in URL', 'Application slug, can be found in URL']" radar="1"/>

## ManicTime

Expand Down
6 changes: 6 additions & 0 deletions docs/en/programming.md
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,12 @@ Subscribe to the updates (threads and submission) from a paritcular Hacker News

<RouteEn author="hellodword" example="/hex-rays/news" path="/hex-rays/news" />

## Huggingface

### Daily Papers

<RouteEn author="zeyugao" example="/huggingface/daily-papers" path="/huggingface/daily-papers" />

## Issue Hunt

### Project Funded
Expand Down
53 changes: 44 additions & 9 deletions docs/en/social-media.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,26 +217,36 @@ Official user RSS:
- RSS: `https://**:instance**/users/**:username**.rss` ([Example](https://pawoo.net/users/pawoo_support.rss))
- Atom: ~~`https://**:instance**/users/**:username**.atom`~~ (Only for pawoo.net, [example](https://pawoo.net/users/pawoo_support.atom))

These feed do not include boosts (a.k.a. reblogs). RSSHub provides a feed for user timeline based on the Mastodon API, but to use that, you will need to create application on a Mastodon instance, and configure your RSSHub instance. Check the [Deploy Guide](/en/install/#route-specific-configurations) for route-specific configurations.
These feed do not include boosts (a.k.a. reblogs). RSSHub provides a feed for user timeline based on the Mastodon API, but to use that, you may need to create application on a Mastodon instance, and configure your RSSHub instance. Check the [Deploy Guide](/en/install/#route-specific-configurations) for route-specific configurations.

:::

### User timeline

<RouteEn author="notofoe" example="/mastodon/acct/CatWhitney@mastodon.social/statuses" path="/mastodon/acct/:acct/statuses/:only_media?" :paramsDesc="['Webfinger account URI', 'whether only display media content, default to false, any value to true']"/>
<RouteEn author="notofoe" example="/mastodon/acct/CatWhitney@mastodon.social/statuses" path="/mastodon/acct/:acct/statuses/:only_media?" :paramsDesc="['Webfinger account URI, like `user@host`', 'whether only display media content, default to false, any value to true']"/>

Started from Mastodon v4.0.0, the use of the `search` API in the route no longer requires a user token.
If the domain of your Webfinger account URI is the same as the API host of the instance (i.e., no delegation called in some other protocols), then no configuration is required and the route is available out of the box.
However, you can still specify these route-specific configurations if you need to override them.

### Instance timeline (local)

<RouteEn author="hoilc" example="/mastodon/timeline/pawoo.net/true" path="/mastodon/timeline/:site/:only_media?" :paramsDesc="['instance address, only domain, no `http://` or `https://` protocol header', 'whether only display media content, default to false, any value to true']"/>

If the instance address is not `mastodon.social` or `pawoo.net`, then the route requires `ALLOW_USER_SUPPLY_UNSAFE_DOMAIN` to be `true`.

### Instance timeline (federated)

<RouteEn author="hoilc" example="/mastodon/remote/pawoo.net/true" path="/mastodon/remote/:site/:only_media?" :paramsDesc="['instance address, only domain, no `http://` or `https://` protocol header', 'whether only display media content, default to false, any value to true']"/>

If the instance address is not `mastodon.social` or `pawoo.net`, then the route requires `ALLOW_USER_SUPPLY_UNSAFE_DOMAIN` to be `true`.

### User timeline (backup)

<RouteEn author="notofoe" example="/mastodon/account_id/mastodon.social/23634/statuses/only_media" path="/mastodon/account/:site/:account_id/statuses/:only_media?" :paramsDesc="['instance address, only domain, no `http://` or `https://` protocol header', 'account id. login your instance, then search for the user profile; the account id is in the url', 'whether only display media content, default to false, any value to true']"/>

If the instance address is not `mastodon.social` or `pawoo.net`, then the route requires `ALLOW_USER_SUPPLY_UNSAFE_DOMAIN` to be `true`.

## Misskey

### Featured Notes
Expand Down Expand Up @@ -430,6 +440,31 @@ Due to Telegram restrictions, some channels involving pornography, copyright, an

<RouteEn author="fengkx" example="/telegram/blog" path="/telegram/blog" />

## Threads

### User timeline

<RouteEn author="ninboy" path="/threads/:user/:routeParams?" example="/threads/zuck" radar="1" rssbud="1" puppeteer="1">

Specify options (in the format of query string) in parameter `routeParams` to control some extra features for threads

| Key | Description | Accepts | Defaults to |
|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------| ---------------------- |-------------|
| `showAuthorInTitle` | Show author name in title | `0`/`1`/`true`/`false` | `true` |
| `showAuthorInDesc` | Show author name in description (RSS body) | `0`/`1`/`true`/`false` | `true` |
| `showQuotedAuthorAvatarInDesc` | Show avatar of quoted author in description (RSS body) (Not recommended if your RSS reader extracts images from description) | `0`/`1`/`true`/`false` | `false` |
| `showAuthorAvatarInDesc` | Show avatar of author in description (RSS body) (Not recommended if your RSS reader extracts images from description) | `0`/`1`/`true`/`false` | `falseP` |
| `showEmojiForQuotesAndReply` | Use "🔁" instead of "QT", "↩️" instead of "Re" | `0`/`1`/`true`/`false` | `true` |
| `showQuotedInTitle` | Show quoted tweet in title | `0`/`1`/`true`/`false` | `true` |
| `replies` | Show replies | `0`/`1`/`true`/`false` | `true` |

Specify different option values than default values to improve readability. The URL

```
https://rsshub.app/threads/zuck/showAuthorInTitle=1&showAuthorInDesc=1&showQuotedAuthorAvatarInDesc=1&showAuthorAvatarInDesc=1&showEmojiForQuotesAndReply=1&showQuotedInTitle=1
```
</RouteEn>

## TikTok

### User
Expand Down Expand Up @@ -484,15 +519,15 @@ generates

### User timeline

<RouteEn author="DIYgod yindaheng98 Rongronggg9" path="/twitter/user/:id/:routeParams?" example="/twitter/user/DIYgod" :paramsDesc="['user id', 'extra parameters, see the table above; particularly when `routeParams=exclude_replies`, replies are excluded; `routeParams=exclude_rts` excludes retweets,`routeParams=exclude_rts_replies` exclude replies and retweets; for default include all.']" radar="1" rssbud="1"/>
<RouteEn author="DIYgod yindaheng98 Rongronggg9" path="/twitter/user/:id/:routeParams?" example="/twitter/user/DIYgod" :paramsDesc="['username; in particular, if starts with `+`, it will be recognized as a [unique ID](https://github.com/DIYgod/RSSHub/issues/12221), e.g. `+44196397`', 'extra parameters, see the table above; particularly when `routeParams=exclude_replies`, replies are excluded; `routeParams=exclude_rts` excludes retweets,`routeParams=exclude_rts_replies` exclude replies and retweets; for default include all.']" radar="1" rssbud="1"/>

### User media

<RouteEn author="yindaheng98 Rongronggg9" path="/twitter/media/:id/:routeParams?" example="/twitter/media/DIYgod" :paramsDesc="['user id', 'extra parameters, see the table above.']" radar="1" rssbud="1"/>
<RouteEn author="yindaheng98 Rongronggg9" path="/twitter/media/:id/:routeParams?" example="/twitter/media/DIYgod" :paramsDesc="['username; in particular, if starts with `+`, it will be recognized as a [unique ID](https://github.com/DIYgod/RSSHub/issues/12221), e.g. `+44196397`', 'extra parameters, see the table above.']" radar="1" rssbud="1"/>

### User following timeline

<RouteEn author="DIYgod" example="/twitter/followings/DIYgod" path="/twitter/followings/:id/:routeParams?" :paramsDesc="['user id', 'extra parameters, see the table above']" radar="1" rssbud="1" selfhost="1">
<RouteEn author="DIYgod" example="/twitter/followings/DIYgod" path="/twitter/followings/:id/:routeParams?" :paramsDesc="['username', 'extra parameters, see the table above']" radar="1" rssbud="1" selfhost="1">

::: warning

Expand All @@ -504,11 +539,11 @@ This route requires Twitter token's corresponding id, therefore it's only availa

### List timeline

<RouteEn author="xyqfer" example="/twitter/list/ladyleet/javascript" path="/twitter/list/:id/:name/:routeParams?" :paramsDesc="['user name', 'list name', 'extra parameters, see the table above']" radar="1" rssbud="1"/>
<RouteEn author="xyqfer" example="/twitter/list/ladyleet/javascript" path="/twitter/list/:id/:name/:routeParams?" :paramsDesc="['username', 'list name', 'extra parameters, see the table above']" radar="1" rssbud="1"/>

### User likes

<RouteEn author="xyqfer" example="/twitter/likes/DIYgod" path="/twitter/likes/:id/:routeParams?" :paramsDesc="['user name', 'extra parameters, see the table above']" radar="1" rssbud="1"/>
<RouteEn author="xyqfer" example="/twitter/likes/DIYgod" path="/twitter/likes/:id/:routeParams?" :paramsDesc="['username', 'extra parameters, see the table above']" radar="1" rssbud="1"/>

### Keyword

Expand All @@ -520,7 +555,7 @@ This route requires Twitter token's corresponding id, therefore it's only availa

### Collection

<RouteEn author="TonyRL" example="/twitter/collection/DIYgod/1527857429467172864" path="/twitter/collection/:uid/:collectionId/:routeParams?" :paramsDesc="['User name, should match the generated token', 'Collection ID, can be found in URL', 'extra parameters, see the table above']" radar="1" rssbud="1" selfhost="1">
<RouteEn author="TonyRL" example="/twitter/collection/DIYgod/1527857429467172864" path="/twitter/collection/:uid/:collectionId/:routeParams?" :paramsDesc="['username, should match the generated token', 'collection ID, can be found in URL', 'extra parameters, see the table above']" radar="1" rssbud="1" selfhost="1">

::: warning

Expand All @@ -532,7 +567,7 @@ This route requires Twitter token's corresponding id, therefore it's only availa

### Tweet Details

<Route author="LarchLiu" example="/twitter/tweet/DIYgod/status/1650844643997646852" path="/twitter/tweet/:id/status/:status/:original?" :paramsDesc="['User name', 'Tweet ID', 'extra parameters, data type of return, if the value is not `0`/`false` and `config.isPackage` is `true`, return the original data of twitter']" radar="1" rssbud="1"/>
<Route author="LarchLiu Rongronggg9" example="/twitter/tweet/DIYgod/status/1650844643997646852" path="/twitter/tweet/:id/status/:status/:original?" :paramsDesc="['username; in particular, if starts with `+`, it will be recognized as a [unique ID](https://github.com/DIYgod/RSSHub/issues/12221), e.g. `+44196397`', 'tweet ID', 'extra parameters, data type of return, if the value is not `0`/`false` and `config.isPackage` is `true`, return the original data of twitter']" radar="1" rssbud="1"/>

## Vimeo

Expand Down
8 changes: 4 additions & 4 deletions docs/en/traditional-media.md
Original file line number Diff line number Diff line change
Expand Up @@ -390,12 +390,12 @@ Parameters can be obtained from the official website, for instance:

### Category/Topic/Author

<RouteEn author="HenryQW proletarius101 LyleLee" example="/reuters/world/us" path="/reuters/:category/:topic?" :paramsDesc="['find it in the URL, or tables below', 'find it in the URL, or tables below']">
<RouteEn author="HenryQW proletarius101 LyleLee nczitzk" example="/reuters/world/us" path="/reuters/:category/:topic?" :paramsDesc="['find it in the URL, or tables below', 'find it in the URL, or tables below']">

- `:category`:
| World | Business | Legal | Markets | Breakingviews | Technology |
| -------- | ------- | ----- | -------- | ------------- | ---------- |
| world | business | legal | markets | breakingviews | technology |
| World | Business | Legal | Markets | Breakingviews | Technology | Graphics |
| ----- | -------- | ----- | ------- | ------------- | ---------- | -------- |
| world | business | legal | markets | breakingviews | technology | graphics |

- `world/:topic`:

Expand Down
6 changes: 6 additions & 0 deletions docs/finance.md
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,12 @@ TokenInsight 官方亦有提供 RSS,可参考 <https://api.tokeninsight.com/re

</Route>

## 汇通网

### 7x24 小时快讯

<Route author="occupy5 dousha" example="/fx678/kx" path="/fx678/kx" radar="1"/>

## 金十数据

### 市场快讯
Expand Down
22 changes: 22 additions & 0 deletions docs/game.md
Original file line number Diff line number Diff line change
Expand Up @@ -623,6 +623,12 @@ News 的数据来自 <https://warthunder.com/en/news/>

<Route author="DIYgod" example="/mhw/news" path="/mhw/news" radar="1" rssbud="1"/>

## 盒心光环

### 资讯

<Route author="XXY233" example="/xboxfan/news" path="/xboxfan/news" radar="1"/>

## 剑网 3

### 新闻资讯
Expand Down Expand Up @@ -769,6 +775,22 @@ Example:`https://www.iyingdi.com/tz/people/55547` ,id 是 `55547`

<Route author="hoilc" example="/cowlevel/element/1370" path="/cowlevel/element/:id" :paramsDesc="['元素 ID, 可在 URL 中找到']" radar="1" rssbud="1"/>

## 其乐

### 论坛

<Route author="nczitzk" example="/keylol" path="/keylol/:path+" :paramsDesc="['路径,默认为热点聚焦']">

::: tip 提示

若订阅 [热点聚焦](https://keylol.com/f161-1),网址为 <https://keylol.com/f161-1>。截取 `https://keylol.com/` 到末尾的部分 `f161-1` 作为参数,此时路由为 [`/keylol/f161-1`](https://rsshub.app/keylol/f161-1)

若订阅子分类 [试玩免费 - 热点聚焦](https://keylol.com/forum.php?mod=forumdisplay\&fid=161\&filter=typeid\&typeid=459),网址为 <https://keylol.com/forum.php?mod=forumdisplay&fid=161&filter=typeid&typeid=459>。截取 `https://keylol.com/forum.php?mod=forumdisplay&` 到末尾的部分 `fid=161&filter=typeid&typeid=459` 作为参数,此时路由为 [`/keylol/fid=161&filter=typeid&typeid=459`](https://rsshub.app/keylol/fid=161\&filter=typeid\&typeid=459)

:::

</Route>

## 少女前线

### 情报局
Expand Down
16 changes: 16 additions & 0 deletions docs/government.md
Original file line number Diff line number Diff line change
Expand Up @@ -1112,6 +1112,22 @@ pageClass: routes

</Route>

## 中国军网

### 军队人才网

<Route author="nczitzk" example="/81/81rc" path="/81/81rc/:path+" :paramsDesc="['路径,默认为工作动态']">

::: tip 提示

若订阅 [文职人员 - 工作动态](https://81rc.81.cn/wzry/gzdt),网址为 <https://81rc.81.cn/wzry/gzdt>。截取 `https://81rc.81.cn` 到末尾的部分 `/wzry/gzdt` 作为参数,此时路由为 [`/81/81rc/wzry/gzdt`](https://rsshub.app/81/81rc/wzry/gzdt)

若订阅子分类 [文职人员 - 各部门各单位招考动态](https://81rc.81.cn/wzry/jwjgbmhddwzkdt),网址为 <https://81rc.81.cn/wzry/jwjgbmhddwzkdt>。截取 `https://81rc.81.cn` 到末尾的部分 `/wzry/jwjgbmhddwzkdt` 作为参数,此时路由为 [`/81/81rc/wzry/jwjgbmhddwzkdt`](https://rsshub.app/81/81rc/wzry/jwjgbmhddwzkdt)

:::

</Route>

## 中国科学技术协会

### 通用
Expand Down
6 changes: 3 additions & 3 deletions docs/install/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -799,9 +799,9 @@ RSSHub 支持使用访问密钥 / 码,白名单和黑名单三种方式进行

- Mastodon 用户时间线路由:访问 `https://mastodon.example/settings/applications` 申请(替换掉 `mastodon.example`)。需要 `read:search` 权限

- `MASTODON_API_HOST`: API 请求的实例
- `MASTODON_API_HOST`: API 请求的实例,仅域名,不包括 `http://``https://` 协议头
- `MASTODON_API_ACCESS_TOKEN`: 用户 access token, 申请应用后,在应用配置页可以看到申请者的 access token
- `MASTODON_API_ACCT_DOMAIN`: 该实例本地用户 acct 标识的域名
- `MASTODON_API_ACCT_DOMAIN`: 该实例本地用户 acct 标识的域名,Webfinger account URI,形如 `user@host`

- Medium 相关路由:打开控制台,复制 Cookie(理论上只需要 uid 和 sid 即可)

Expand Down Expand Up @@ -867,7 +867,7 @@ RSSHub 支持使用访问密钥 / 码,白名单和黑名单三种方式进行

- `TWITTER_CONSUMER_KEY`: Twitter Developer API key,支持多个 key,用英文逗号 `,` 隔开
- `TWITTER_CONSUMER_SECRET`: Twitter Developer API key secret,支持多个 key,用英文逗号 `,` 隔开,顺序与 key 对应
- `TWITTER_WEBAPI_AUTHORIZAION`: Twitter Web API authorization。如果上述两个环境变量中的任意一个未设置,就会使用 Twitter Web API。然而,没有必要设置这个环境变量,因为所有用户和访客共享同一个 authorization token 且已经内置于 RSSHub 之中
- `TWITTER_WEBAPI_AUTHORIZAION`: Twitter Web API authorization,格式为 `key:secret`,支持多个,用英文逗号 `,` 隔开。如果上述两个环境变量中的任意一个未设置,就会使用 Twitter Web API。然而,没有必要设置这个环境变量,因为 RSSHub 已经内置了目前已知可用的 token
- `TWITTER_TOKEN_{handler}`: 对应 Twitter 用户名生成的 token,`{handler}` 替换为用于生成该 token 的 Twitter 用户名,值为 `Twitter API key, Twitter API key secret, Access token, Access token secret` 用逗号隔开,例如:`TWITTER_TOKEN_RSSHub=bX1zry5nG4d1RbESQbnADpVIo,2YrD8qo9sXbB8VlYfVmo1Qtw0xsexnOliU5oZofq7aPIGou0Xx,123456789-hlkUHFYmeXrRcf6SEQciP8rP4lzmRgMgwdqIN9aK,pHcPnfa28rCIKhSICUCiaw9ppuSSl7T2f3dnGYpSM0bod`

- Wordpress
Expand Down
Loading

0 comments on commit 47d1423

Please sign in to comment.