diff --git a/.vitepress/theme/components/InstanceList.vue b/.vitepress/theme/components/InstanceList.vue index f0518ab52..b54aad29b 100644 --- a/.vitepress/theme/components/InstanceList.vue +++ b/.vitepress/theme/components/InstanceList.vue @@ -107,6 +107,12 @@ const instances = [{ location: '🇩🇪', maintainer: 'Vincent Yang', maintainerUrl: 'https://missuo.me', + }, + { + url: 'https://rss.wudifeixue.com', + location: '🇨🇦', + maintainer: 'wudifeixue', + maintainerUrl: 'https://github.com/wudifeixue', } ] 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/deploy/index.md b/src/deploy/index.md index 8291d02d1..c0e24c034 100644 --- a/src/deploy/index.md +++ b/src/deploy/index.md @@ -485,7 +485,7 @@ Automatic updates are included. 3. [Sign up for Fly.io](https://fly.io/app/sign-up) and install the [flyctl CLI](https://fly.io/docs/hands-on/install-flyctl/); 4. Run `fly launch` and choose a unique name and region to deploy; -5. Use `fly secrets set KEY=VALUE` to [configure some modules](#configuration-route-specific-configurations); +5. Use `fly secrets set KEY=VALUE` to [configure some modules](config#route-specific-configurations); 6. [Set up automatic deployment via GitHub Actions](https://fly.io/docs/app-guides/continuous-deployment-with-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). @@ -503,7 +503,7 @@ Upgrade: On the homepage of your Forked repository, click "Sync fork - Update Br ``` Depending on the actual situation, you may want to use other image tags, please read the relevant content of [Docker Image](#docker-image); -4. Modify the `[env]` section in fly.toml or use `fly secrets set KEY=VALUE` to [configure some modules](#configuration-route-specific-configurations); +4. Modify the `[env]` section in fly.toml or use `fly secrets set KEY=VALUE` to [configure some modules](config#route-specific-configurations); 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). diff --git a/src/guide/faqs.md b/src/guide/faqs.md index 83308a6de..9055dd443 100644 --- a/src/guide/faqs.md +++ b/src/guide/faqs.md @@ -13,12 +13,12 @@ **A:** RSSHub fetches and respects the original image/video URLs from original sites, in which some are behind anti-hotlink filters. `referrerpolicy="no-referrer"` attribute is added to all images to solve the issues caused by cross-domain requests. Third party RSS service providers such as Feedly and Inoreader, strip this attribute off, resulting in cross-domain requests being blocked. Meanwhile, the attribute is not available for videos yet, resulting in most RSS readers unable to pass the anti-hotlink check. Here are some workarounds: 1. Migrate to RSS readers that do not send Referer，such as [Inoreader for Web](https://www.inoreader.com/) with a [user script disabling Referer](https://greasyfork.org/en/scripts/376884), [fix-image-error at inoreader](https://greasyfork.org/scripts/463461-fix-image-error-at-inoreader), [RSS to Telegram Bot](https://github.com/Rongronggg9/RSS-to-Telegram-Bot), etc. If your RSS reader can bypass the anti-hotlink check successfully and play embedded videos, it's an RSS reader that do not send Referer. Please consider adding it to the documentation to help more people. -2. Set up a reverse proxy, refer to [Parameters->Multimedia processing](/parameter#multimedia-processing) for more details. +2. Set up a reverse proxy, refer to [Parameters->Multimedia processing](/guide/parameters#multimedia-processing) for more details. 3. Navigate back to the original site. **Q: The website I want is not supported QAQ** -**A:** If you are a JavaScript developer, please follow [this guide](/joinus/quick-start) for submitting a pull request, otherwise, follow the issue template to [submit a new issue](https://github.com/DIYgod/RSSHub/issues/new?template=rss_request_en.md), and patiently wait for Santa Claus. For priority responses, consider [sponsoring us](/support). +**A:** If you are a JavaScript developer, please follow [this guide](/joinus/#quick-start) for submitting a pull request, otherwise, follow the issue template to [submit a new issue](https://github.com/DIYgod/RSSHub/issues/new?template=rss_request_en.md), and patiently wait for Santa Claus. For priority responses, consider [sponsoring us](/sponsor). **Q: Where do I get the changelog for RSSHub？** diff --git a/src/guide/index.md b/src/guide/index.md index 865136e99..073d32f7f 100644 --- a/src/guide/index.md +++ b/src/guide/index.md @@ -8,13 +8,13 @@ To subscribe to a Twitter user's timeline, first look at the route document of [ The demo instance will generate an RSS feed at `https://rsshub.app/twitter/user/DIYgod`, use your own domain name when applicable. This feed should work with all RSS readers conforming to the RSS Standard. -You can replace the domain name `https://rsshub.app` with your [self-hosted instance](/install) or any [public instance](/instances). +You can replace the domain name `https://rsshub.app` with your [self-hosted instance](/deploy) or any [public instance](/guide/instances). -RSSHub supports additional parameters such as content filtering and full-text extraction, refer to [Parameters](/parameter) for details. +RSSHub supports additional parameters such as content filtering and full-text extraction, refer to [Parameters](/parameters) for details. ## Contribute a New Route -Our thriving community is the key to RSSHub's success, we invite everyone to join us and [contribute new routes](/joinus/quick-start) for all kinds of interesting sources. +Our thriving community is the key to RSSHub's success, we invite everyone to join us and [contribute new routes](/joinus/#quick-start) for all kinds of interesting sources. ## Use as a npm Package diff --git a/src/guide/instances.md b/src/guide/instances.md index f98fa6904..232127d29 100644 --- a/src/guide/instances.md +++ b/src/guide/instances.md @@ -2,7 +2,7 @@ Although the official instances are already stable enough, in order to achieve decentralization, we encourage users to host their own RSSHub instances or use other public RSSHub instances. -If you are willing to contribute your own instance for others to use, please edit [this file](https://github.com/DIYgod/RSSHub/tree/master/website/src/components/InstanceList.tsx) and submit a PR to add your instance to the list. +If you are willing to contribute your own instance for others to use, please edit [this file](https://github.com/RSSNext/rsshub-docs/edit/main/.vitepress/theme/components/InstanceList.vue) and submit a PR to add your instance to the list. ## Official diff --git a/src/guide/parameters.md b/src/guide/parameters.md index f8828ccc1..8d698b6be 100644 --- a/src/guide/parameters.md +++ b/src/guide/parameters.md @@ -87,7 +87,7 @@ E.g. Bilibili article [https://rsshub.app/bilibili/user/article/334958638?mode=f ## Access Control -Set `key` or `code` to grant access to requests. See [Access Control Configuration](install/#configuration-access-control-configuration-access-key-code). +Set `key` or `code` to grant access to requests. See [Access Control Configuration](/deploy/config#access-control-configurations). ## Telegram Instant View @@ -127,7 +127,7 @@ This is an experimental API - `multimedia_hotlink_template`: the same as `image_hotlink_template` but apply to audio and video. Note: the service must follow redirects, allow reverse-proxy for audio and video, and must drop the `Referer` header when reverse-proxying. [Here is an easy-to-deploy project that fits these requirements](https://github.com/Rongronggg9/rsstt-img-relay). The project accepts simple URL concatenation, e.g. `https://example.com/${href}`, in which `example.com` should be replaced with the domain name of the service you've deployed - `wrap_multimedia_in_iframe`: wrap audio and video in `