From a1449ee40eed1f72fd75e6fa881ee044ed8b356d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=B8=96=E7=95=8C?= Date: Fri, 8 Sep 2023 11:52:15 +0800 Subject: [PATCH] Mark deprecated features --- docs/deprecated.md | 13 +++++++++++++ inbound/default_tcp.go | 2 +- mkdocs.yml | 3 ++- outbound/shadowsocksr.go | 1 + 4 files changed, 17 insertions(+), 2 deletions(-) create mode 100644 docs/deprecated.md diff --git a/docs/deprecated.md b/docs/deprecated.md new file mode 100644 index 00000000..521a3994 --- /dev/null +++ b/docs/deprecated.md @@ -0,0 +1,13 @@ +# Deprecated Feature List + +The following features will be marked deprecated in 1.5.0 and removed entirely in 1.6.0. + +#### ShadowsocksR + +ShadowsocksR support has never been enabled by default, since the most commonly used proxy sales panel in the +illegal industry stopped using this protocol, it does not make sense to continue to maintain it. + +#### Proxy Protocol + +Proxy Protocol is added by Pull Request, has problems, is only used by the backend of HTTP multiplexers such as nginx, +is intrusive, and is meaningless for proxy purposes. diff --git a/inbound/default_tcp.go b/inbound/default_tcp.go index ef01bfac..4e408f5c 100644 --- a/inbound/default_tcp.go +++ b/inbound/default_tcp.go @@ -35,7 +35,7 @@ func (a *myInboundAdapter) ListenTCP() (net.Listener, error) { a.logger.Info("tcp server started at ", tcpListener.Addr()) } if a.listenOptions.ProxyProtocol { - a.logger.Debug("proxy protocol enabled") + a.logger.Warn("Proxy Protocol is deprecated, see https://sing-box.sagernet.org/deprecated") tcpListener = &proxyproto.Listener{Listener: tcpListener, AcceptNoHeader: a.listenOptions.ProxyProtocolAcceptNoHeader} } a.tcpListener = tcpListener diff --git a/mkdocs.yml b/mkdocs.yml index 24d5133c..7c29f4f1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -30,9 +30,10 @@ theme: - navigation.sections - header.autohide nav: - - Getting Started: + - Home: - index.md - Features: features.md + - Deprecated: deprecated.md - Support: support.md - Change Log: changelog.md - Installation: diff --git a/outbound/shadowsocksr.go b/outbound/shadowsocksr.go index f8e4e4b3..099db32a 100644 --- a/outbound/shadowsocksr.go +++ b/outbound/shadowsocksr.go @@ -37,6 +37,7 @@ type ShadowsocksR struct { } func NewShadowsocksR(ctx context.Context, router adapter.Router, logger log.ContextLogger, tag string, options option.ShadowsocksROutboundOptions) (*ShadowsocksR, error) { + logger.Warn("ShadowsocksR is deprecated, see https://sing-box.sagernet.org/deprecated") outboundDialer, err := dialer.New(router, options.DialerOptions) if err != nil { return nil, err