Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@txthinking
txthinking committed Jul 30, 2024
1 parent 24bb390 commit 4f7ef11
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
8 changes: 4 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down
8 changes: 4 additions & 4 deletions docs/gui.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down
8 changes: 4 additions & 4 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1407,7 +1407,7 @@ <h2 id="cli">CLI</h2>
<li>Not all apps will use this proxy, whether they use it is up to the app itself.</li>
<li>Generally, all UDP protocols will not go through this proxy, such as http3.</li>
</ol>
<p>For the specifics of socks5 and http proxy, you can read <a href="https://www.txthinking.com/talks/articles/socks5-and-http-proxy.article">this article</a>.</p>
<p>For the specifics of socks5 and http proxy, you can read <a href="https://www.txthinking.com/talks/articles/socks5-and-http-proxy-en.article">this article</a>.</p>
<h2 id="gui">GUI</h2>
<p>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&#39;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.</p>
<h2 id="without-brook-basic-knowledge-of-network-requests">Without Brook: Basic Knowledge of Network Requests</h2>
Expand Down Expand Up @@ -1451,7 +1451,7 @@ <h2 id="with-brook-fake-dns-on">With Brook: Fake DNS On</h2>
<li>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.</li>
<li>Even with Fake DNS enabled, but the app uses the system&#39;s secure DNS or the app&#39;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.</li>
</ul>
<p>To avoid the ineffectiveness of Fake DNS, please refer to <a href="https://www.txthinking.com/talks/articles/brook-fakedns.article">this article</a>.</p>
<p>To avoid the ineffectiveness of Fake DNS, please refer to <a href="https://www.txthinking.com/talks/articles/brook-fakedns-en.article">this article</a>.</p>
<h2 id="with-brook-fake-dns-off">With Brook: Fake DNS Off</h2>
<ol>
<li>When an app requests a domain address, such as <code>google.com:443</code></li>
Expand Down Expand Up @@ -2019,7 +2019,7 @@ <h2 id="ca">CA</h2>
<p>Some software may not read the system CA，you can use <code>curl --cacert ~/.nami/bin/ca.pem</code> to debug</p>
</blockquote>
<h2 id="openwrt">OpenWrt</h2>
<p><a href="https://www.txthinking.com/talks/articles/brook-openwrt-en.article">https://www.txthinking.com/talks/articles/brook-openwrt-en.article</a></p>
<p><a href="https://www.txthinking.com/talks/articles/brook-openwrt-en.article">Brook OpenWRT: Perfectly supports IPv4/IPv6/TCP/UDP</a></p>
<h2 id="ipv6">IPv6</h2>
<p>Brook&#39;s stance on IPv6 is positive, if your server or local environment doesn&#39;t have an IPv6 stack, read <a href="https://www.txthinking.com/talks/articles/brook-ipv6-en.article">this article</a>.</p>
<h2 id="troubleshooting-steps">Troubleshooting Steps</h2>
Expand All @@ -2042,7 +2042,7 @@ <h2 id="troubleshooting-steps">Troubleshooting Steps</h2>
<li>Test TCP and UDP: Use the <code>Echo Client</code> for testing. If the echo server entered is a domain address, it will trigger DNS resolution.</li>
<li>Ensure the effectiveness of Fake DNS: Fake DNS is essential to do something with a domain or domain address. Generally, enable the <code>Block Google Secure DNS</code> module is sufficient. For other cases, refer to <a href="https://www.txthinking.com/talks/articles/brook-fakedns-en.article">this article</a>.</li>
<li>If your local or Server does not support IPv6: Refer to <a href="https://www.txthinking.com/talks/articles/brook-ipv6-en.article">this article</a>.</li>
<li>macOS App Mode: Refer to <a href="https://www.txthinking.com/talks/articles/macos-app-mode.article">this article</a>.</li>
<li>macOS App Mode: Refer to <a href="https://www.txthinking.com/talks/articles/macos-app-mode-en.article">this article</a>.</li>
<li>Windows:<ul>
<li>The client can pass the tests without any special configuration on a brand-new, genuine Windows 11.</li>
<li>Be aware that the Windows system time is often incorrect.</li>
Expand Down

0 comments on commit 4f7ef11

Please sign in to comment.