Shadowrocket Glossary Interface, Protocols, and Rule Keywords
First distinguish interface entry points, connection protocols, matching conditions, and actions, then look up the relevant parameters. This page keeps interface terms such as Home, Config, and Global Routing in their original English. When a term appears in different places, interpret it within its context; do not confuse the server list, configuration file, and system connection status.
For looking up Shadowrocket terms on iPhone, iPad, Mac (Apple silicon and Intel), Windows, Android, and Linux. Interface locations may vary by platform; follow the current app interface.
You’ll need your own subscription or server details before getting started. This site does not provide, sell, or recommend servers or subscriptions; a one-time client purchase is not a service plan. iPhone and iPad: $2.99 one-time purchase on the App Store. Mac, Windows, Android, and Linux: free. See downloads for all platforms.
These terms explain where to perform an action and which traffic-handling mode is active. An enabled toggle, a selected server, and an active rule are three different states; check each separately.
Interface and Toggles
Home
Home is the main place to view server and subscription entries, select a server, and manage the connection. Selecting an entry makes it available as a proxy; Global Routing and the configuration determine which requests use it. When troubleshooting, check the selection in the list first, then the connection status. An entry in the list does not mean you are connected.
Interface and Toggles
Add Server
Add Server lets you enter existing server details manually. Choose the protocol first, then fill in the corresponding fields. Matching addresses and ports do not mean different protocols can share the rest of their parameters; check authentication, transport, and TLS settings individually. If details are missing, ask the service provider rather than guessing from field names.
Interface and Toggles
Global Routing
Global Routing determines how traffic is handled overall: Config uses the current configuration, while Proxy and Direct route traffic through a proxy or connect directly. When checking a domain rule, first make sure Config is selected; otherwise, changes to the rule file may not affect the current request path.
Interface and Toggles
Proxy / Direct
Proxy and Direct are options in the Global Routing interface, not server protocol names. Proxy routes traffic through a proxy overall; Direct connects directly. These modes can help narrow down a problem, but results still depend on DNS, the destination service, and network conditions. The uppercase PROXY and DIRECT in rule files are action keywords; see Rule Actions.
Interface and Toggles
On Demand
On Demand starts or restores a connection when specified conditions are met. It controls when a connection is made, not which route each domain takes, so it cannot replace rule-based routing. If a connection returns after you turn it off manually, check the On Demand conditions and related system settings rather than just removing the server entry from Home.
Interface and Toggles
Connectivity Test
Connectivity Test checks a target using the selected test method. The result applies only to that test. A successful test to one server does not mean every website, UDP request, or app service will work. If a test fails, check the target, protocol parameters, and current network first, then use Log to identify where the failure occurs.
A protocol describes how the client and server exchange data; it is not a speed rating. Use your existing connection details and check protocol, authentication, transport, and security parameters together.
Protocols
Shadowsocks
Shadowsocks establishes a proxy connection using agreed parameters such as an encryption method and password. The server address, port, encryption method, and password must match; checking the password alone cannot rule out a configuration error. Enter any additional parameters according to the original instructions rather than copying settings from another entry.
Protocols
VMess
VMess authenticates with user credentials and supports different transport methods. In addition to the UUID, check the actual transport, Host, Path, and TLS parameters provided. An inaccurate device clock can also affect authentication, so check the system time if you encounter a handshake or authentication error.
Protocols
VLESS
VLESS separates identity from transport and security settings; the UUID is only part of the connection details. The required transport and security parameters must match the server settings. Similar protocol names do not mean protocols are interchangeable. If a connection fails after import, compare each field with the original details instead of disabling security checks at random.
Protocols
Trojan
Trojan commonly uses TLS and authenticates with a password. The connection address, domain on the certificate, and TLS parameters may serve different purposes; a resolvable address does not eliminate the need to check the rest. For certificate errors, check the domain, device time, and server certificate status. Do not make skipping verification your default fix.
Protocols
Hysteria2
Hysteria2 is a QUIC-based proxy protocol that relies on a suitable UDP path. If the address and authentication details are correct but the connection still fails, check whether the current network allows the relevant UDP traffic. Set adjustable parameters such as bandwidth according to the network and server instructions; entering a higher value does not increase available bandwidth.
Protocols
WireGuard
WireGuard establishes a tunnel using public and private keys and peer settings. Keep PrivateKey secret; PublicKey identifies the corresponding peer. AllowedIPs specifies routing ranges, while MTU affects packet size—neither is an authentication password. If some requests stall, check the handshake, address, routing ranges, and MTU.
Protocols
HTTP / SOCKS5
HTTP and SOCKS5 are two types of proxy protocol and may require an address, port, and authentication details. The protocol name alone does not mean traffic is encrypted; UDP support depends on the implementation and configuration. When using either as a proxy endpoint, restrict access to prevent unnecessary devices from connecting through an exposed port.
Read each rule as a matching condition plus a final action. The example below demonstrates syntax only; example.com is a sample domain, not a server or subscription address.
Rules connect request-matching conditions with actions. They are usually checked in configuration order, and the first matching rule applies. More specific conditions generally belong before broader ones; otherwise, later rules may never match. When troubleshooting, check the active file, rule order, and actual match records—not just whether a domain appears somewhere in the file.
Rule Keywords
DOMAIN / DOMAIN-SUFFIX / DOMAIN-KEYWORD
DOMAIN matches an exact domain, DOMAIN-SUFFIX matches a specified domain and its subdomains, and DOMAIN-KEYWORD matches a keyword in the domain. For example, DOMAIN-SUFFIX,example.com,PROXY can match example.com and its subdomains. Keyword matching can be broad, so consider whether it might also match unrelated domains.
Rule Keywords
GEOIP
GEOIP matches a destination address using its region tag in an IP geolocation database; it does not use a website's language or the user's location. Database records, DNS results, and the distribution of a service's IP addresses can all affect the match. If a domain resolves to multiple addresses and results vary between requests, check the actual resolved addresses.
Rule Keywords
IP-CIDR / IP-CIDR6
IP-CIDR matches IPv4 ranges; IP-CIDR6 matches IPv6 ranges. The prefix length after the slash determines the range size. A shorter prefix generally covers more addresses, so an incorrect range can affect many requests. If a domain returns both IPv4 and IPv6 addresses, checking only one type of rule may not explain every connection.
Rule Keywords
USER-AGENT
USER-AGENT matches the User-Agent field in visible requests; it is not a general way to identify every app process. Fields in encrypted requests are usually not directly readable, so this rule alone cannot show that all traffic from an app will match. Before using it, check the protocol, field visibility, and actual match records.
Rule Keywords
FINAL
FINAL sets the action for requests not matched by earlier rules and is usually placed at the end of the rule list. FINAL,DIRECT sends remaining requests directly; it does not change requests already matched by earlier rules. Changing the final action may affect many destinations without individual rules, so keep a copy of the original file for recovery.
Rule Keywords
PROXY / DIRECT / REJECT
PROXY, DIRECT, and REJECT are rule action keywords meaning use the proxy route, connect directly, and reject the request, respectively. They are not domain-matching conditions or server protocols. If a request is rejected, look for the matching REJECT rule first. If traffic exits through an unexpected route, check the matched action and where it leads.
Server entries hold connection details, subscriptions update groups of entries, and Config contains configuration settings. A successful import only means the data was read; verify that the connection and rules behave as expected.
Subscriptions and Configurations
Subscribe
Subscribe saves and updates a group of server entries using a link from your existing service. An update may change entry names, counts, or parameters, but does not necessarily replace the current Config. Subscription links may contain personal access credentials; remove the full link from screenshots, logs, and support requests.
Subscriptions and Configurations
Server / Node
A server or node here means a set of remote connection details the client can use, typically including an address, port, protocol, and authentication information. The display name helps identify an entry but does not prove its location, bandwidth, or availability. Before editing an entry created by a subscription, consider whether a later update will overwrite your changes.
Subscriptions and Configurations
Config
Config can mean either the interface for managing configuration files or the Global Routing mode that handles requests according to a configuration. A configuration file may contain rules, DNS settings, and more, but its contents depend on the file; a subscription list is not a complete configuration. Back up the current file before switching or updating it remotely, and check referenced resources and the final action.
Subscriptions and Configurations
Scan QR Code
Scan QR Code reads connection details from a QR code, which may contain a single server entry or a link the app can recognize. Scanning does not verify the connection; check the protocol, address, port, and authentication fields after importing. QR codes may contain sensitive information, so avoid sharing an unredacted image of one you use.
Subscriptions and Configurations
URL Rewrite
URL Rewrite processes request URLs according to matching conditions. It is a different layer from rules that decide whether a request uses a proxy or connects directly. What it can process depends on the protocol, encryption, and configuration conditions; it does not necessarily apply to every request. Review each rule's scope before using an existing configuration, and avoid letting unfamiliar rules disrupt normal requests.
Record the original value before changing a setting, and change only one variable at a time. Defaults and available options depend on the current app interface; these definitions do not replace an assessment of your network conditions.
Settings
DNS
DNS resolves domain names to addresses. Successful resolution and a successful connection to the destination are separate steps. The path used for DNS queries does not by itself show the final route for app traffic; check rules and connection records separately. If a domain fails to load but its address is reachable, check the DNS response, cache, and DNS settings in the configuration.
Settings
Ping / Latency
Ping or latency results show response time under specific test conditions; they do not directly indicate download speed. Different test methods, targets, and network loads produce different results, so use the same method when comparing. A single timeout does not necessarily mean a server is completely unavailable; check actual requests and Connectivity Test as well.
Settings
Log
Log records connection, rule-match, and error details. Use it to distinguish issues such as DNS resolution failures, authentication failures, and destination rejections. Reproduce the problem first, then look for records around the same time to avoid confusion with older errors. Before sharing logs, remove server addresses, authentication details, subscription links, and other identifiable access information.
Settings
Widget
A Widget is a system-displayed component that shows app status or provides an action. Available content depends on the platform and app capabilities. The system controls when widgets refresh, so what they show may not be current. To check whether you are connected, verify the status in the app and system rather than relying on a single widget update.
Settings
iCloud Sync
iCloud Sync transfers data supported by the app when device and account conditions allow; it is not a complete device backup. System permissions, connection authorization, and some local settings may still need to be confirmed on a new device. Before switching devices, check that sync is complete and export important Config files separately. After restoring, verify the selected server and rule behavior.
Settings
Proxy Port
The Proxy port is the local port on which a proxy service listens; it is different from the port used by the remote server. Access from other devices also depends on the listening address, local network permissions, and firewall settings. If you do not need access from other devices, restrict the access scope. After changing the port, check the address and port used by connecting devices as well.