From 4f7ef11b55971a95d21b835f8a3a97828b7aa296 Mon Sep 17 00:00:00 2001 From: txthinking Date: Tue, 30 Jul 2024 17:20:54 +0800 Subject: [PATCH] update docs --- README.md | 8 ++++---- docs/gui.md | 8 ++++---- docs/index.html | 8 ++++---- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index d36292d1..543c02b1 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ Before discussing the GUI client, let's first talk about the command line client 1. Not all apps will use this proxy, whether they use it is up to the app itself. 2. Generally, all UDP protocols will not go through this proxy, such as http3. -For the specifics of socks5 and http proxy, you can read [this article](https://www.txthinking.com/talks/articles/socks5-and-http-proxy.article). +For the specifics of socks5 and http proxy, you can read [this article](https://www.txthinking.com/talks/articles/socks5-and-http-proxy-en.article). ## GUI @@ -82,7 +82,7 @@ However, if the following situations occur, the domain name will not/cannot be p - Fake DNS not enabled: in this case, the Brook client will not attempt to parse the domain name from the request sent to the system DNS and will treat it as a normal request sent to an IP address. - Even with Fake DNS enabled, but the app uses the system's secure DNS or the app's own secure DNS: in this case, the Brook client cannot parse the domain name from the request sent to the secure DNS and will treat it as a normal request sent to an IP address. -To avoid the ineffectiveness of Fake DNS, please refer to [this article](https://www.txthinking.com/talks/articles/brook-fakedns.article). +To avoid the ineffectiveness of Fake DNS, please refer to [this article](https://www.txthinking.com/talks/articles/brook-fakedns-en.article). ## With Brook: Fake DNS Off @@ -345,7 +345,7 @@ https://txthinking.github.io/ca/ca.pem ## OpenWrt -https://www.txthinking.com/talks/articles/brook-openwrt-en.article +[Brook OpenWRT: Perfectly supports IPv4/IPv6/TCP/UDP](https://www.txthinking.com/talks/articles/brook-openwrt-en.article) ## IPv6 @@ -369,7 +369,7 @@ Brook's stance on IPv6 is positive, if your server or local environment doesn't 7. Test TCP and UDP: Use the `Echo Client` for testing. If the echo server entered is a domain address, it will trigger DNS resolution. 8. Ensure the effectiveness of Fake DNS: Fake DNS is essential to do something with a domain or domain address. Generally, enable the `Block Google Secure DNS` module is sufficient. For other cases, refer to [this article](https://www.txthinking.com/talks/articles/brook-fakedns-en.article). 9. If your local or Server does not support IPv6: Refer to [this article](https://www.txthinking.com/talks/articles/brook-ipv6-en.article). -10. macOS App Mode: Refer to [this article](https://www.txthinking.com/talks/articles/macos-app-mode.article). +10. macOS App Mode: Refer to [this article](https://www.txthinking.com/talks/articles/macos-app-mode-en.article). 11. Windows: - The client can pass the tests without any special configuration on a brand-new, genuine Windows 11. - Be aware that the Windows system time is often incorrect. diff --git a/docs/gui.md b/docs/gui.md index 338146d3..81ee77d8 100644 --- a/docs/gui.md +++ b/docs/gui.md @@ -9,7 +9,7 @@ Before discussing the GUI client, let's first talk about the command line client 1. Not all apps will use this proxy, whether they use it is up to the app itself. 2. Generally, all UDP protocols will not go through this proxy, such as http3. -For the specifics of socks5 and http proxy, you can read [this article](https://www.txthinking.com/talks/articles/socks5-and-http-proxy.article). +For the specifics of socks5 and http proxy, you can read [this article](https://www.txthinking.com/talks/articles/socks5-and-http-proxy-en.article). ## GUI @@ -51,7 +51,7 @@ However, if the following situations occur, the domain name will not/cannot be p - Fake DNS not enabled: in this case, the Brook client will not attempt to parse the domain name from the request sent to the system DNS and will treat it as a normal request sent to an IP address. - Even with Fake DNS enabled, but the app uses the system's secure DNS or the app's own secure DNS: in this case, the Brook client cannot parse the domain name from the request sent to the secure DNS and will treat it as a normal request sent to an IP address. -To avoid the ineffectiveness of Fake DNS, please refer to [this article](https://www.txthinking.com/talks/articles/brook-fakedns.article). +To avoid the ineffectiveness of Fake DNS, please refer to [this article](https://www.txthinking.com/talks/articles/brook-fakedns-en.article). ## With Brook: Fake DNS Off @@ -314,7 +314,7 @@ https://txthinking.github.io/ca/ca.pem ## OpenWrt -https://www.txthinking.com/talks/articles/brook-openwrt-en.article +[Brook OpenWRT: Perfectly supports IPv4/IPv6/TCP/UDP](https://www.txthinking.com/talks/articles/brook-openwrt-en.article) ## IPv6 @@ -338,7 +338,7 @@ Brook's stance on IPv6 is positive, if your server or local environment doesn't 7. Test TCP and UDP: Use the `Echo Client` for testing. If the echo server entered is a domain address, it will trigger DNS resolution. 8. Ensure the effectiveness of Fake DNS: Fake DNS is essential to do something with a domain or domain address. Generally, enable the `Block Google Secure DNS` module is sufficient. For other cases, refer to [this article](https://www.txthinking.com/talks/articles/brook-fakedns-en.article). 9. If your local or Server does not support IPv6: Refer to [this article](https://www.txthinking.com/talks/articles/brook-ipv6-en.article). -10. macOS App Mode: Refer to [this article](https://www.txthinking.com/talks/articles/macos-app-mode.article). +10. macOS App Mode: Refer to [this article](https://www.txthinking.com/talks/articles/macos-app-mode-en.article). 11. Windows: - The client can pass the tests without any special configuration on a brand-new, genuine Windows 11. - Be aware that the Windows system time is often incorrect. diff --git a/docs/index.html b/docs/index.html index 1266221f..08cce68b 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1407,7 +1407,7 @@

CLI

  • Not all apps will use this proxy, whether they use it is up to the app itself.
  • Generally, all UDP protocols will not go through this proxy, such as http3.
    • -

    For the specifics of socks5 and http proxy, you can read this article.

    +

    For the specifics of socks5 and http proxy, you can read this article.

    GUI

    The GUI client does not use socks5 and http proxy mode, so there is no issue with some software not using the system proxy. Instead, it uses a virtual network card to take over the entire system's network, including UDP-based http3. Moreover, Brook allows us to control network requests programmatically, so it is necessary to have basic knowledge of network requests.

    Without Brook: Basic Knowledge of Network Requests

    @@ -1451,7 +1451,7 @@

    With Brook: Fake DNS On

  • Fake DNS not enabled: in this case, the Brook client will not attempt to parse the domain name from the request sent to the system DNS and will treat it as a normal request sent to an IP address.
  • Even with Fake DNS enabled, but the app uses the system's secure DNS or the app's own secure DNS: in this case, the Brook client cannot parse the domain name from the request sent to the secure DNS and will treat it as a normal request sent to an IP address.
    • -

    To avoid the ineffectiveness of Fake DNS, please refer to this article.

    +

    To avoid the ineffectiveness of Fake DNS, please refer to this article.

    With Brook: Fake DNS Off

    1. When an app requests a domain address, such as google.com:443
      2. @@ -2019,7 +2019,7 @@

      CA

      Some software may not read the system CA，you can use curl --cacert ~/.nami/bin/ca.pem to debug

      OpenWrt

      -

      https://www.txthinking.com/talks/articles/brook-openwrt-en.article

      +

      Brook OpenWRT: Perfectly supports IPv4/IPv6/TCP/UDP

      IPv6

      Brook's stance on IPv6 is positive, if your server or local environment doesn't have an IPv6 stack, read this article.

      Troubleshooting Steps

      @@ -2042,7 +2042,7 @@

      Troubleshooting Steps

    2. Test TCP and UDP: Use the Echo Client for testing. If the echo server entered is a domain address, it will trigger DNS resolution.
    3. Ensure the effectiveness of Fake DNS: Fake DNS is essential to do something with a domain or domain address. Generally, enable the Block Google Secure DNS module is sufficient. For other cases, refer to this article.
    4. If your local or Server does not support IPv6: Refer to this article.
      5. -
    5. macOS App Mode: Refer to this article.
      6. +
    6. macOS App Mode: Refer to this article.
    7. Windows:
      • The client can pass the tests without any special configuration on a brand-new, genuine Windows 11.
      • Be aware that the Windows system time is often incorrect.