diff --git a/src/deploy/config.md b/src/deploy/config.md index e97d1cf97..2a6b897c8 100644 --- a/src/deploy/config.md +++ b/src/deploy/config.md @@ -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. @@ -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) diff --git a/src/guide/parameters.md b/src/guide/parameters.md index 8d698b6be..42fbbb83c 100644 --- a/src/guide/parameters.md +++ b/src/guide/parameters.md @@ -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). ::: diff --git a/src/routes/anime.md b/src/routes/anime.md index 5c837592c..38c47bad8 100644 --- a/src/routes/anime.md +++ b/src/routes/anime.md @@ -174,7 +174,7 @@ :::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 @@ -231,11 +231,11 @@ Sources ### Advanced Search - + ### Filter - + ## NT动漫 diff --git a/src/routes/design.md b/src/routes/design.md index 56d02998b..7d1a2e856 100644 --- a/src/routes/design.md +++ b/src/routes/design.md @@ -58,14 +58,14 @@ Behance user's profile URL, like [https://www.behance.net/mishapetrick](https:// ### Google Fonts - + | 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 diff --git a/src/routes/live.md b/src/routes/live.md index d130ef369..34fc2b0e2 100644 --- a/src/routes/live.md +++ b/src/routes/live.md @@ -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. 点击原文链接打开抖音网页版的视频详情页播放视频。 ::: diff --git a/src/routes/other.md b/src/routes/other.md index e4b59a4ae..acc0473e0 100644 --- a/src/routes/other.md +++ b/src/routes/other.md @@ -513,7 +513,7 @@ JavBus has multiple backup domains, these routes use default domain `https://jav ## Notion :::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 diff --git a/src/routes/social-media.md b/src/routes/social-media.md index d5fb63c37..d6cf3356d 100644 --- a/src/routes/social-media.md +++ b/src/routes/social-media.md @@ -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) @@ -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. 点击原文链接打开抖音网页版的视频详情页播放视频。 ::: diff --git a/src/zh/deploy/config.md b/src/zh/deploy/config.md index b3a7baf1a..8d5953c23 100644 --- a/src/zh/deploy/config.md +++ b/src/zh/deploy/config.md @@ -160,7 +160,7 @@ RSSHub 支持使用访问密钥 / 码进行访问控制。开启将会激活全 :::tip 新配置方式 -我们正在试验新的,更灵活的配置方式。如果有需要,请转到 [通用参数 -> 多媒体处理](/zh/parameter#多媒体处理) 了解更多。 +我们正在试验新的,更灵活的配置方式。如果有需要,请转到 [通用参数 -> 多媒体处理](/zh/guide/parameters#多媒体处理) 了解更多。 在使用新配置时,请将下方环境变量留空。否则默认图片模版会继续遵循下方配置。 @@ -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) diff --git a/src/zh/joinus/advanced/script-standard.md b/src/zh/joinus/advanced/script-standard.md index f8a3dbf59..bb9f38262 100644 --- a/src/zh/joinus/advanced/script-standard.md +++ b/src/zh/joinus/advanced/script-standard.md @@ -162,6 +162,6 @@ const renderAuthor = (author) => art(path.join(__dirname, 'templates/author.art' :::danger -v1 路由规范已被弃用。所有新路由都应遵循 [路由规范](#lu-you-gui-fan)。 +v1 路由规范已被弃用。所有新路由都应遵循 [路由规范](#路由规范-1)。 ::: diff --git a/src/zh/routes/anime.md b/src/zh/routes/anime.md index 658623cca..1cd0d70b5 100644 --- a/src/zh/routes/anime.md +++ b/src/zh/routes/anime.md @@ -171,10 +171,10 @@ ### User Subscriptions - + :::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 @@ -231,11 +231,11 @@ Sources ### Advanced Search - + ### Filter - + ## NT动漫 diff --git a/src/zh/routes/design.md b/src/zh/routes/design.md index 37f95c42f..04945967c 100644 --- a/src/zh/routes/design.md +++ b/src/zh/routes/design.md @@ -58,14 +58,14 @@ Behance user's profile URL, like [https://www.behance.net/mishapetrick](https:// ### Google Fonts - + | 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 diff --git a/src/zh/routes/live.md b/src/zh/routes/live.md index 56adee119..651a91b7c 100644 --- a/src/zh/routes/live.md +++ b/src/zh/routes/live.md @@ -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. 点击原文链接打开抖音网页版的视频详情页播放视频。 ::: diff --git a/src/zh/routes/other.md b/src/zh/routes/other.md index e27721313..0e0d2b185 100644 --- a/src/zh/routes/other.md +++ b/src/zh/routes/other.md @@ -537,7 +537,7 @@ JavBus has multiple backup domains, these routes use default domain `https://jav ## Notion :::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 diff --git a/src/zh/routes/social-media.md b/src/zh/routes/social-media.md index e815fe44d..ed6d5bad7 100644 --- a/src/zh/routes/social-media.md +++ b/src/zh/routes/social-media.md @@ -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) @@ -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. 点击原文链接打开抖音网页版的视频详情页播放视频。 :::