deprecated

Documentation

Index

• Variables
• func Report(ctx context.Context, feature Note)
• type Manager
  • func NewStderrManager(logger logger.Logger) Manager
• type Note
  • func (n Note) Impending() bool
  • func (n Note) Message() string
  • func (n Note) MessageWithLink() string

Variables

var OptionBadMatchSource = Note{
	Name:              "bad-match-source",
	Description:       "legacy match source rule item",
	DeprecatedVersion: "1.10.0",
	ScheduledVersion:  "1.11.0",
	EnvName:           "BAD_MATCH_SOURCE",
	MigrationLink:     "https://sing-box.sagernet.org/deprecated/#match-source-rule-items-are-renamed",
}

var OptionDestinationOverrideFields = Note{
	Name:              "destination-override-fields",
	Description:       "destination override fields in direct outbound",
	DeprecatedVersion: "1.11.0",
	ScheduledVersion:  "1.13.0",
	EnvName:           "DESTINATION_OVERRIDE_FIELDS",
	MigrationLink:     "https://sing-box.sagernet.org/migration/#migrate-destination-override-fields-to-route-options",
}

var OptionGEOIP = Note{
	Name:              "geoip",
	Description:       "geoip database",
	DeprecatedVersion: "1.8.0",
	ScheduledVersion:  "1.12.0",
	EnvName:           "GEOIP",
	MigrationLink:     "https://sing-box.sagernet.org/migration/#migrate-geoip-to-rule-sets",
}

var OptionGEOSITE = Note{
	Name:              "geosite",
	Description:       "geosite database",
	DeprecatedVersion: "1.8.0",
	ScheduledVersion:  "1.12.0",
	EnvName:           "GEOSITE",
	MigrationLink:     "https://sing-box.sagernet.org/migration/#migrate-geosite-to-rule-sets",
}

var OptionInboundOptions = Note{
	Name:              "inbound-options",
	Description:       "legacy inbound fields",
	DeprecatedVersion: "1.11.0",
	ScheduledVersion:  "1.13.0",
	EnvName:           "INBOUND_OPTIONS",
	MigrationLink:     "https://sing-box.sagernet.org/migration/#migrate-legacy-special-outbounds-to-rule-actions",
}

var OptionLegacyDNSFakeIPOptions = Note{
	Name:              "legacy-dns-fakeip-options",
	Description:       "legacy DNS fakeip options",
	DeprecatedVersion: "1.12.0",
	ScheduledVersion:  "1.14.0",
}

var OptionLegacyDNSTransport = Note{
	Name:              "legacy-dns-transport",
	Description:       "legacy DNS transport",
	DeprecatedVersion: "1.12.0",
	ScheduledVersion:  "1.14.0",
	EnvName:           "LEGACY_DNS_TRANSPORT",
}

var OptionMissingDomainResolver = Note{
	Name:              "missing-domain-resolver",
	Description:       "missing `route.default_domain_resolver` or `domain_resolver` in dial fields",
	DeprecatedVersion: "1.12.0",
	ScheduledVersion:  "1.14.0",
}

var OptionOutboundDNSRuleItem = Note{
	Name:              "outbound-dns-rule-item",
	Description:       "outbound DNS rule item",
	DeprecatedVersion: "1.12.0",
	ScheduledVersion:  "1.14.0",
}

var OptionSpecialOutbounds = Note{
	Name:              "special-outbounds",
	Description:       "legacy special outbounds",
	DeprecatedVersion: "1.11.0",
	ScheduledVersion:  "1.13.0",
	EnvName:           "SPECIAL_OUTBOUNDS",
	MigrationLink:     "https://sing-box.sagernet.org/migration/#migrate-legacy-special-outbounds-to-rule-actions",
}

var OptionTUNAddressX = Note{
	Name:              "tun-address-x",
	Description:       "legacy tun address fields",
	DeprecatedVersion: "1.10.0",
	ScheduledVersion:  "1.12.0",
	EnvName:           "TUN_ADDRESS_X",
	MigrationLink:     "https://sing-box.sagernet.org/migration/#tun-address-fields-are-merged",
}

var OptionTUNGSO = Note{
	Name:              "tun-gso",
	Description:       "GSO option in tun",
	DeprecatedVersion: "1.11.0",
	ScheduledVersion:  "1.12.0",
	EnvName:           "TUN_GSO",
}

var OptionWireGuardGSO = Note{
	Name:              "wireguard-gso",
	Description:       "GSO option in wireguard outbound",
	DeprecatedVersion: "1.11.0",
	ScheduledVersion:  "1.13.0",
	EnvName:           "WIREGUARD_GSO",
	MigrationLink:     "https://sing-box.sagernet.org/migration/#migrate-wireguard-outbound-to-endpoint",
}

var OptionWireGuardOutbound = Note{
	Name:              "wireguard-outbound",
	Description:       "legacy wireguard outbound",
	DeprecatedVersion: "1.11.0",
	ScheduledVersion:  "1.13.0",
	EnvName:           "WIREGUARD_OUTBOUND",
	MigrationLink:     "https://sing-box.sagernet.org/migration/#migrate-wireguard-outbound-to-endpoint",
}

var Options = []Note{
	OptionBadMatchSource,
	OptionGEOIP,
	OptionGEOSITE,
	OptionTUNAddressX,
	OptionSpecialOutbounds,
	OptionInboundOptions,
	OptionDestinationOverrideFields,
	OptionWireGuardOutbound,
	OptionWireGuardGSO,
	OptionTUNGSO,
	OptionLegacyDNSTransport,
	OptionLegacyDNSFakeIPOptions,
	OptionOutboundDNSRuleItem,
	OptionMissingDomainResolver,
}

Functions

func Report

func Report(ctx context.Context, feature Note)

Types

type Manager

type Manager interface {
	ReportDeprecated(feature Note)
}

func NewStderrManager

func NewStderrManager(logger logger.Logger) Manager

type Note

type Note struct {
	Name              string
	Description       string
	DeprecatedVersion string
	ScheduledVersion  string
	EnvName           string
	MigrationLink     string
}

func (Note) Impending

func (n Note) Impending() bool

func (Note) Message

func (n Note) Message() string

func (Note) MessageWithLink

func (n Note) MessageWithLink() string