Skip to content

Commit

Permalink
docs: fix all 'parameter/' and 'route-specific-configurations'
Browse files Browse the repository at this point in the history
  • Loading branch information
wudifeixue committed Mar 30, 2024
1 parent 67ec7fc commit 854aa3c
Show file tree
Hide file tree
Showing 14 changed files with 27 additions and 27 deletions.
6 changes: 3 additions & 3 deletions src/deploy/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ Access code is the md5 generated based on the access key + route, eg:

:::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).
We are currently testing out a new format, providing end-user with more flexibility. For more info, please refer to [Parameters->Multimedia processing](/guide/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.

Expand Down Expand Up @@ -192,9 +192,9 @@ Configs in this sections are in beta stage, and **are turn off by default**. Ple

:::

`ALLOW_USER_HOTLINK_TEMPLATE`: [Parameters->Multimedia processing](/parameter#multimedia-processing)
`ALLOW_USER_HOTLINK_TEMPLATE`: [Parameters->Multimedia processing](/guide/parameters#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.
`FILTER_REGEX_ENGINE`: Define Regex engine used in [Parameters->filtering](/guide/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)](https://owasp.org/www-community/attacks/Server_Side_Request_Forgery)

Expand Down
2 changes: 1 addition & 1 deletion src/guide/parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Please make sure you've [fully URL-encoded](https://gchq.github.io/CyberChef/#re

filter supports Regex, and due to the fact that some Regex are vulnerable to DoS (ReDoS), default engine `re2` blocks some of these functionalities available in node `Regexp`. These two engines also behaves a bit different in some corner cases. [Details](https://github.com/uhop/node-re2#limitations-things-re2-does-not-support)

If you need to use a different engine, please refer to [Deploy->Features->FILTER_REGEX_ENGINE](/deploy/#configuration-features).
If you need to use a different engine, please refer to [Deploy->Features->FILTER_REGEX_ENGINE](/deploy/config#features).

:::

Expand Down
6 changes: 3 additions & 3 deletions src/routes/anime.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@
<Route namespace="iwara" :data='{"path":"/subscriptions","categories":["anime"],"example":"/iwara/subscriptions","parameters":{},"features":{"requireConfig":[{"name":"IWARA_USERNAME","description":""},{"name":"IWARA_PASSWORD","description":""}],"requirePuppeteer":false,"antiCrawler":false,"supportBT":false,"supportPodcast":false,"supportScihub":false},"radar":[{"source":["ecchi.iwara.tv/"]}],"name":"User Subscriptions","maintainers":["FeCCC"],"url":"ecchi.iwara.tv/","description":":::warning\n This route requires username and password, therefore it&#39;s only available when self-hosting, refer to the [Deploy Guide](/deploy/#route-specific-configurations) for route-specific configurations.\n :::","location":"subscriptions.ts"}' :test='undefined' />

:::warning
This route requires username and password, therefore it's only available when self-hosting, refer to the [Deploy Guide](/deploy/#route-specific-configurations) for route-specific configurations.
This route requires username and password, therefore it's only available when self-hosting, refer to the [Deploy Guide](/deploy/config#route-specific-configurations) for route-specific configurations.
:::

## Kemono <Site url="kemono.su"/>
Expand Down Expand Up @@ -231,11 +231,11 @@ Sources

### Advanced Search <Site url="nhentai.net" size="sm" />

<Route namespace="nhentai" :data='{"path":"/search/:keyword/:mode?","categories":["anime"],"example":"/nhentai/search/language%3Ajapanese+-scat+-yaoi+-guro+-\"mosaic+censorship\"","parameters":{"keyword":"Keywords for search. You can copy the content after `q=` after searching on the original website, or you can enter it directly. See the [official website](https://nhentai.net/info/) for details","mode":"mode, `simple` to only show cover, `detail` to show all pages, `torrent` to include Magnet URI, need login, refer to [Route-specific Configurations](/deploy/#configuration-route-specific-configurations), default to `simple`"},"features":{"requireConfig":false,"requirePuppeteer":false,"antiCrawler":true,"supportBT":true,"supportPodcast":false,"supportScihub":false},"radar":[{"source":["nhentai.net/:key/:keyword"],"target":"/:key/:keyword"}],"name":"Advanced Search","maintainers":["MegrezZhu","hoilc"],"location":"search.ts"}' :test='{"code":1,"message":"expected 503 to be 200 // Object.is equality"}' />
<Route namespace="nhentai" :data='{"path":"/search/:keyword/:mode?","categories":["anime"],"example":"/nhentai/search/language%3Ajapanese+-scat+-yaoi+-guro+-\"mosaic+censorship\"","parameters":{"keyword":"Keywords for search. You can copy the content after `q=` after searching on the original website, or you can enter it directly. See the [official website](https://nhentai.net/info/) for details","mode":"mode, `simple` to only show cover, `detail` to show all pages, `torrent` to include Magnet URI, need login, refer to [Route-specific Configurations](/deploy/config#route-specific-configurations), default to `simple`"},"features":{"requireConfig":false,"requirePuppeteer":false,"antiCrawler":true,"supportBT":true,"supportPodcast":false,"supportScihub":false},"radar":[{"source":["nhentai.net/:key/:keyword"],"target":"/:key/:keyword"}],"name":"Advanced Search","maintainers":["MegrezZhu","hoilc"],"location":"search.ts"}' :test='{"code":1,"message":"expected 503 to be 200 // Object.is equality"}' />

### Filter <Site url="nhentai.net" size="sm" />

<Route namespace="nhentai" :data='{"path":"/:key/:keyword/:mode?","categories":["anime"],"example":"/nhentai/language/chinese","parameters":{"key":"Filter term, can be: `parody`, `character`, `tag`, `artist`, `group`, `language` or `category`","keyword":"Filter value","mode":"mode, `simple` to only show cover, `detail` to show all pages, `torrent` to include Magnet URI, need login, refer to [Route-specific Configurations](/deploy/#configuration-route-specific-configurations), default to `simple`"},"features":{"requireConfig":false,"requirePuppeteer":false,"antiCrawler":true,"supportBT":true,"supportPodcast":false,"supportScihub":false},"radar":[{"source":["nhentai.net/:key/:keyword"],"target":"/:key/:keyword"}],"name":"Filter","maintainers":["MegrezZhu","hoilc"],"location":"other.ts"}' :test='{"code":1,"message":"expected 503 to be 200 // Object.is equality"}' />
<Route namespace="nhentai" :data='{"path":"/:key/:keyword/:mode?","categories":["anime"],"example":"/nhentai/language/chinese","parameters":{"key":"Filter term, can be: `parody`, `character`, `tag`, `artist`, `group`, `language` or `category`","keyword":"Filter value","mode":"mode, `simple` to only show cover, `detail` to show all pages, `torrent` to include Magnet URI, need login, refer to [Route-specific Configurations](/deploy/config#route-specific-configurations), default to `simple`"},"features":{"requireConfig":false,"requirePuppeteer":false,"antiCrawler":true,"supportBT":true,"supportPodcast":false,"supportScihub":false},"radar":[{"source":["nhentai.net/:key/:keyword"],"target":"/:key/:keyword"}],"name":"Filter","maintainers":["MegrezZhu","hoilc"],"location":"other.ts"}' :test='{"code":1,"message":"expected 503 to be 200 // Object.is equality"}' />

## NT动漫 <Site url="www.ntdm9.com"/>

Expand Down
4 changes: 2 additions & 2 deletions src/routes/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,14 @@ Behance user's profile URL, like [https://www.behance.net/mishapetrick](https://

### Google Fonts <Site url="www.google.com" size="sm" />

<Route namespace="google" :data='{"path":"/fonts/:sort?","categories":["design"],"example":"/google/fonts/date","parameters":{"sort":"Sorting type, see below, default to `date`"},"features":{"requireConfig":[{"name":"GOOGLE_FONTS_API_KEY","description":""}],"requirePuppeteer":false,"antiCrawler":false,"supportBT":false,"supportPodcast":false,"supportScihub":false},"name":"Google Fonts","maintainers":["Fatpandac"],"description":"| Newest | Trending | Most popular | Name | Number of styles |\n | :----: | :------: | :----------: | :---: | :--------------: |\n | date | trending | popularity | alpha | style |\n\n :::warning\n This route requires API key, therefore it&#39;s only available when self-hosting, refer to the [Deploy Guide](https://docs.rsshub.app/deploy/#configuration-route-specific-configurations) for route-specific configurations.\n :::","location":"fonts.ts"}' :test='undefined' />
<Route namespace="google" :data='{"path":"/fonts/:sort?","categories":["design"],"example":"/google/fonts/date","parameters":{"sort":"Sorting type, see below, default to `date`"},"features":{"requireConfig":[{"name":"GOOGLE_FONTS_API_KEY","description":""}],"requirePuppeteer":false,"antiCrawler":false,"supportBT":false,"supportPodcast":false,"supportScihub":false},"name":"Google Fonts","maintainers":["Fatpandac"],"description":"| Newest | Trending | Most popular | Name | Number of styles |\n | :----: | :------: | :----------: | :---: | :--------------: |\n | date | trending | popularity | alpha | style |\n\n :::warning\n This route requires API key, therefore it&#39;s only available when self-hosting, refer to the [Deploy Guide](https://docs.rsshub.app/deploy/config#route-specific-configurations) for route-specific configurations.\n :::","location":"fonts.ts"}' :test='undefined' />

| Newest | Trending | Most popular | Name | Number of styles |
| :----: | :------: | :----------: | :---: | :--------------: |
| date | trending | popularity | alpha | style |

:::warning
This route requires API key, therefore it's only available when self-hosting, refer to the [Deploy Guide](https://docs.rsshub.app/deploy/#configuration-route-specific-configurations) for route-specific configurations.
This route requires API key, therefore it's only available when self-hosting, refer to the [Deploy Guide](https://docs.rsshub.app/deploy/config#route-specific-configurations) for route-specific configurations.
:::

## Notefolio <Site url="notefolio.net"/>
Expand Down
2 changes: 1 addition & 1 deletion src/routes/live.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
:::warning
反爬严格,需要启用 puppeteer。抖音的视频 CDN 会验证 Referer,意味着许多阅读器都无法直接播放内嵌视频,以下是一些变通解决方案:

1. 启用内嵌视频 (`embed=1`), 参考 [通用参数 -> 多媒体处理](/parameter#多媒体处理) 配置 `multimedia_hotlink_template` **** `wrap_multimedia_in_iframe`
1. 启用内嵌视频 (`embed=1`), 参考 [通用参数 -> 多媒体处理](/zh/guide/parameters#多媒体处理) 配置 `multimedia_hotlink_template` **** `wrap_multimedia_in_iframe`
2. 关闭内嵌视频 (`embed=0`),手动点击 `视频直链` 超链接,一般情况下均可成功播放视频。若仍然出现 HTTP 403,请复制 URL 以后到浏览器打开。
3. 点击原文链接打开抖音网页版的视频详情页播放视频。
:::
Expand Down
2 changes: 1 addition & 1 deletion src/routes/other.md
Original file line number Diff line number Diff line change
Expand Up @@ -513,7 +513,7 @@ JavBus has multiple backup domains, these routes use default domain `https://jav
## Notion <Site url="notion.so"/>

:::warning
Need to set up Notion integration, please refer to [Route-specific Configurations](https://docs.rsshub.app/deploy/#Deployment) for details.
Need to set up Notion integration, please refer to [Route-specific Configurations](https://docs.rsshub.app/deploy/config#route-specific-configurations) for details.
:::

:::tip Recommendation
Expand Down
4 changes: 2 additions & 2 deletions src/routes/social-media.md
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@ 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 may need to create application on a Mastodon instance, and configure your RSSHub instance. Check the [Deploy Guide](/deploy/#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](/deploy/config#route-specific-configurations) for route-specific configurations.
:::

### Instance timeline (local) <Site url="mastodon.social" size="sm" />
Expand Down Expand Up @@ -855,7 +855,7 @@ Chart
:::warning
反爬严格,需要启用 puppeteer。抖音的视频 CDN 会验证 Referer,意味着许多阅读器都无法直接播放内嵌视频,以下是一些变通解决方案:

1. 启用内嵌视频 (`embed=1`), 参考 [通用参数 -> 多媒体处理](/parameter#多媒体处理) 配置 `multimedia_hotlink_template` **** `wrap_multimedia_in_iframe`
1. 启用内嵌视频 (`embed=1`), 参考 [通用参数 -> 多媒体处理](/zh/guide/parameters#多媒体处理) 配置 `multimedia_hotlink_template` **** `wrap_multimedia_in_iframe`
2. 关闭内嵌视频 (`embed=0`),手动点击 `视频直链` 超链接,一般情况下均可成功播放视频。若仍然出现 HTTP 403,请复制 URL 以后到浏览器打开。
3. 点击原文链接打开抖音网页版的视频详情页播放视频。
:::
Expand Down
6 changes: 3 additions & 3 deletions src/zh/deploy/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ RSSHub 支持使用访问密钥 / 码进行访问控制。开启将会激活全

:::tip 新配置方式

我们正在试验新的,更灵活的配置方式。如果有需要,请转到 [通用参数 -> 多媒体处理](/zh/parameter#多媒体处理) 了解更多。
我们正在试验新的,更灵活的配置方式。如果有需要,请转到 [通用参数 -> 多媒体处理](/zh/guide/parameters#多媒体处理) 了解更多。

在使用新配置时,请将下方环境变量留空。否则默认图片模版会继续遵循下方配置。

Expand Down Expand Up @@ -190,9 +190,9 @@ RSSHub 支持使用访问密钥 / 码进行访问控制。开启将会激活全

:::

`ALLOW_USER_HOTLINK_TEMPLATE`: [通用参数 -> 多媒体处理](/zh/parameter#多媒体处理)特性控制
`ALLOW_USER_HOTLINK_TEMPLATE`: [通用参数 -> 多媒体处理](/zh/guide/parameters#多媒体处理)特性控制

`FILTER_REGEX_ENGINE`: 控制 [通用参数 -> 内容过滤](/zh/parameter#内容过滤) 使用的正则引擎。可选`[re2, regexp]`,默认`re2`。我们推荐公开实例不要调整这个选项,这个选项目前主要用于向后兼容。
`FILTER_REGEX_ENGINE`: 控制 [通用参数 -> 内容过滤](/zh/guide/parameters#内容过滤) 使用的正则引擎。可选`[re2, regexp]`,默认`re2`。我们推荐公开实例不要调整这个选项,这个选项目前主要用于向后兼容。

`ALLOW_USER_SUPPLY_UNSAFE_DOMAIN`: 允许用户为路由提供域名作为参数。建议公共实例不要调整此选项,开启后可能会导致 [服务端请求伪造(SSRF)](https://owasp.org/www-community/attacks/Server_Side_Request_Forgery)

Expand Down
2 changes: 1 addition & 1 deletion src/zh/joinus/advanced/script-standard.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,6 @@ const renderAuthor = (author) => art(path.join(__dirname, 'templates/author.art'

:::danger

v1 路由规范已被弃用。所有新路由都应遵循 [路由规范](#lu-you-gui-fan)
v1 路由规范已被弃用。所有新路由都应遵循 [路由规范](#路由规范-1)

:::
Loading

0 comments on commit 854aa3c

Please sign in to comment.