From c71f6ba3771bdcceda75c2707db584ddbea1f3ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=B8=96=E7=95=8C?= Date: Sun, 21 Aug 2022 16:19:50 +0800 Subject: [PATCH] Add FAQ page --- constant/dns.go | 11 ----------- constant/version.go | 2 +- docs/configuration/outbound/shadowsocks.md | 2 -- docs/faq.md | 23 ++++++++++++++++++++++ mkdocs.yml | 1 + 5 files changed, 25 insertions(+), 14 deletions(-) delete mode 100644 constant/dns.go create mode 100644 docs/faq.md diff --git a/constant/dns.go b/constant/dns.go deleted file mode 100644 index b58057d9..00000000 --- a/constant/dns.go +++ /dev/null @@ -1,11 +0,0 @@ -package constant - -type DomainStrategy = uint8 - -const ( - DomainStrategyAsIS DomainStrategy = iota - DomainStrategyPreferIPv4 - DomainStrategyPreferIPv6 - DomainStrategyUseIPv4 - DomainStrategyUseIPv6 -) diff --git a/constant/version.go b/constant/version.go index 69cf5449..b9048fe8 100644 --- a/constant/version.go +++ b/constant/version.go @@ -1,6 +1,6 @@ package constant var ( - Version = "0.1.0" + Version = "1.0" Commit = "" ) diff --git a/docs/configuration/outbound/shadowsocks.md b/docs/configuration/outbound/shadowsocks.md index 20672090..2cbc2d5b 100644 --- a/docs/configuration/outbound/shadowsocks.md +++ b/docs/configuration/outbound/shadowsocks.md @@ -1,5 +1,3 @@ -`socks` outbound is a socks4/socks4a/socks5 client. - ### Structure ```json diff --git a/docs/faq.md b/docs/faq.md new file mode 100644 index 00000000..519c86e8 --- /dev/null +++ b/docs/faq.md @@ -0,0 +1,23 @@ +# Frequently Asked Questions (FAQ) + +## Design + +#### Why does sing-box not have feature X? + +Every program contains novel features and omits someone's favorite feature. sing-box is designed with an eye to the needs of performance, lightweight, usability, modularity, and code quality. Your favorite feature may be missing because it doesn't fit, because it compromises performance or design clarity, or because it's a bad idea. + +If it bothers you that sing-box is missing feature X, please forgive us and investigate the features that sing-box does have. You might find that they compensate in interesting ways for the lack of X. + +#### Fake IP + +Fake IP (also called Fake DNS) is an invasive and imperfect DNS solution that breaks expected behavior, causes DNS leaks and makes many software unusable. It is recommended by some software that lacks DNS processing and caching, but sing-box does not need this. + +#### Naive outbound + +NaïveProxy's main function is chromium's network stack, and it makes no sense to implement only its transport protocol. + +#### Protocol combinations + +The "underlying transport" in v2ray-core is actually a combination of a number of proprietary protocols and uses the names of their upstream protocols, resulting in a great deal of Linguistic corruption. + +For example, Trojan with v2ray's proprietary gRPC protocol, called Trojan gRPC by the v2ray community, is not actually a protocol and has no role outside of abusing CDNs. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 2d6e454f..774268ef 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -80,6 +80,7 @@ nav: - Shared: - TLS: configuration/shared/tls.md - Multiplex: configuration/shared/multiplex.md + - FAQ: faq.md - Examples: - examples/index.md - Linux Server Installation: examples/linux-server-installation.md