Official Manual / Glossary
Shadowrocket Glossary
Look up the original interface labels and configuration keywords. Keep three things separate: whether a connection is established, which rule a request matches, and which policy is applied after the match.
01 / Interface
Interface & Controls
The connection toggle controls the connection; Global Routing determines how requests are handled. Check them separately.
- Home
- The screen for checking the connection toggle, server list, and current Global Routing option. Selecting a server does not turn on the connection, and turning on the connection does not mean every request goes through a proxy.
- Global Routing
- Offers three modes: configuration, proxy, and direct connection, shown in the interface as Config, Proxy, and Direct. Config applies the policy defined by the current configuration, Proxy uses the proxy route, and Direct connects directly. When checking which rule matched, first make sure Config is selected.
- On Demand
- Starts a connection when specified conditions are met, such as connecting based on the network in use. It controls when a connection starts; once connected, Global Routing and the current configuration determine how requests are handled.
- Add Server
- Use this to enter details for a server you already have. Select the matching protocol, then enter the address, port, and required protocol-specific fields. Saving only confirms that the entry was added.
- Connectivity Test
- Checks whether the server responds on the current network under the test conditions. A successful test does not verify the target app; if it fails, first check the test target, server settings, and network.
- Latency
- The time from starting a test to receiving a response, usually shown in milliseconds. Latency is not transfer speed. For a meaningful comparison, use the same network, test target, and measurement method.
02 / Protocols
Protocols
The protocol determines how the client communicates with an existing server. The same address or port does not mean protocols or settings are interchangeable.
- Shadowsocks
- A proxy protocol that uses encrypted transport. Server details typically include an address, port, password, and encryption method. If the encryption method or password differs between the client and server, they cannot exchange data properly even if the address is reachable.
- VMess
- A protocol that establishes a proxy connection using parameters such as a user ID. When entering existing server details, also check the transport method and applicable security settings; an address and port alone are not enough to confirm the entry is complete.
- VLESS
- A proxy protocol that uses a user ID. The protocol name alone does not indicate whether transport is encrypted. Check TLS and other security settings against the server details, and do not assume they match the fields in a VMess entry.
- Trojan
- A proxy protocol that typically authenticates with a password over a TLS connection. The server address may differ from the name used for certificate validation. Check each against the existing server details instead of inferring one from the other.
- Hysteria2
- A QUIC-based proxy protocol that uses UDP for transport. If the server details are correct but the connection fails on a particular network, check whether that network allows the relevant UDP traffic.
- WireGuard
- A tunneling protocol that identifies the peer with keys. The peer address and allowed address ranges in the configuration serve different purposes: the former specifies where to connect, while the latter helps determine which destination addresses use the tunnel. Do not share your private key in public notes or screenshots.
03 / Matching
Rule Keywords & Policies
Keywords determine the matching condition; policies determine what happens after a match. For the full syntax, see Configuration Fields.
- Rules
- An entry in
[Rule]that specifies a matching condition and handling policy. Rules are generally checked from top to bottom, and the matching policy is applied. If two rules can match, do not assume the more specific one takes priority automatically.
- DOMAIN
- Matches the full hostname. For example,
DOMAIN,example.com,DIRECTcan matchexample.com, but it will not also matchwww.example.com. Matching does not include a URL path or query parameters.
- DOMAIN-SUFFIX
- Matches by domain suffix, covering the specified domain and its subdomains. For example, the condition
example.commatches bothexample.comandwww.example.com, but notnotexample.com.
- GEOIP
- Matches based on the geographic location of an IP address associated with the request, as recorded in a geolocation database. This is not device location. A domain may resolve to different addresses, so rule matches can change when DNS results change.
- IP-CIDR / IP-CIDR6
- Matches by IPv4 or IPv6 network prefix, such as
192.0.2.0/24and2001:db8::/32. The number after the slash is the prefix length, not a port. Check each address family separately.
- FINAL
- Sets a fallback policy for requests that did not match any preceding entry, and is usually placed at the end of the rule list. For example,
FINAL,DIRECTsends unmatched requests directly; it does not change the policy of requests already matched by an earlier rule.
- PROXY / DIRECT / REJECT
- Three policies used in rules:
PROXYforwards through a proxy,DIRECTconnects directly, andREJECTrejects the request. These uppercase keywords describe the action for a matching rule; they do not change the Proxy or Direct option in Global Routing.
04 / Configuration
Subscriptions & Configuration
Server details answer “where to connect”; a configuration file answers “how to handle requests.” This site explains how to use details you already have and does not provide, sell, or recommend servers or subscriptions.
- Server
- A remote service the client connects to. A server entry stores connection parameters such as the protocol, address, and port. The display name in the list is only a label; it is not a substitute for the actual address and does not mean the entry is ready to use.
- Subscription
- A way to retrieve or refresh server entries using an existing subscription URL. Your service provider supplies the URL, which may contain access credentials, so avoid sharing it publicly. If a previously selected entry is removed after a refresh, select an entry from the updated list.
- Config
- As a tab, it manages configuration files; as a Global Routing option, it means requests are handled according to the current configuration. Before editing, check which file is active to avoid changing an unused copy.
- DNS
- The mechanism used to look up addresses for domain names. A domain lookup failure, a different IP rule match after resolution, and a failed connection to the destination are separate troubleshooting stages. Start with the DNS fields in the General configuration guide.
- URL Rewrite
- A section in a configuration file that handles matching requests based on URL conditions, commonly used for redirects. It is different from path selection in
[Rule]: check changes to the request destination separately from whether the request is routed through a proxy.
- iCloud Sync
- Syncs supported app data across devices when account, system settings, and app support requirements are met. Before switching devices, confirm that the entries you want to keep have synced. This is separate from App Store purchase records.
To add details you already have to the client, follow the steps in Quick Start. If you have added them but cannot connect, see Connection Troubleshooting.
05 / Store & Account
Store & Account
App Store purchase records, app data on your device, and server services are three separate things.
- App Store storefront
- The store region associated with an account, which affects available apps, pricing currency, and purchase requirements. Opening the US product page in a browser does not mean the purchase account signed in on your device uses that storefront.
- App ID
- An identifier for an App Store product listing. When checking the Shadowrocket product page, verify App ID
932747118, developer Shadow Launch Technology Limited, and the official icon—not just the name.
- Purchased Items
- The place to find App Store purchase records. When switching devices or reinstalling, first sign in with the original purchase account, then follow the Purchased Items restore guide to get the app again. Reinstalling the app does not also restore server entries or configuration files.