Shadowrocket Official Manual
Shadowrocket Glossary
Is an item on screen a navigation entry or a toggle? Does a configuration line specify a condition or an action? Browse by category or share a link to an individual term.
Interface & Controls
First check whether the connection is on; then check which mode handles traffic when it is.
- Home
- The main screen shows the connection toggle, server list, and current status. Selecting a server only sets the remote endpoint that may be used; it does not start a connection while the toggle is off. If the toggle is on but traffic behaves unexpectedly, check Global Routing.
- Global Routing
- This setting selects how connections are handled.
Configapplies rules from the active configuration,Proxyroutes traffic through the selected proxy, andDirectconnects without a proxy server. Changing modes does not rewrite rules in the configuration file.
- Config
- This term has two uses: as an interface entry, it opens and manages configuration files; as a
Global Routingoption, it handles connections according to the active configuration. After importing a file, check both which file is enabled and which mode is selected before testing its rules.
- On Demand
- On Demand lets the system start a connection when configured conditions are met, such as reassessing the connection after a network change. It controls when a connection starts, not which route a domain takes. If the connection comes back after you disconnect manually, check the On Demand conditions first, then review the routing rules.
- Connectivity Test
- A connectivity test sends a test request to check whether the current network and server combination is reachable. The reported time depends on the test method, target, and network conditions; it is not a measure of download speed. A successful test also does not verify every routing rule in the configuration.
Proxy Protocols
A protocol defines how the client communicates with a remote server. When entering settings manually, use the server parameters you already have.
- Shadowsocks
- The client communicates with the server using an agreed encryption method and credentials. The address and port specify where to connect; the encryption method and credentials determine whether both sides can process the data correctly. Even if the server address is reachable, choosing the wrong encryption method can cause proxy requests to fail.
- VMess
- This protocol typically uses a UUID to identify the user. The protocol name alone does not specify the server's transport; the transport and related fields must match the parameters you have. If the connection fails, check the user ID and transport settings separately rather than changing both at once.
- VLESS
- This protocol also typically uses a UUID to identify the user, but similar-looking credentials do not mean you can reuse settings from another protocol. Transport security depends on a separately configured security layer, such as TLS. Check the protocol, transport, and security options separately when entering the settings.
- Trojan
- Connections typically use TLS and password authentication. The server address specifies where to connect;
SNIis the service name sent during the TLS handshake. They serve different purposes. If the certificate name is reported as incorrect, first check the name provided by the service rather than disabling certificate verification.
- Hysteria2
- This QUIC-based proxy protocol uses UDP at the transport layer. Confirming that a TCP service is reachable does not show that UDP traffic can pass over the same network. When troubleshooting, check network conditions separately from the address, port, and authentication details.
- WireGuard
- This tunneling protocol identifies the peer with keys and encapsulates data over UDP. The peer's public key identifies the remote endpoint; the local private key identifies your device. They are not interchangeable. Do not disclose your private key when documenting settings or sharing troubleshooting information.
Rule Keywords
When reading a rule, first check what it matches, then check what happens when it matches.
- DOMAIN
- Matches an exact hostname. A condition such as
example.comdoes not automatically includewww.example.com. A hostname does not include a URL scheme, path, or query string.
- DOMAIN-SUFFIX
- Matches a domain and its subdomains by suffix. For example,
example.commatchesapi.example.com, but notnotexample.com. To handle a specific subdomain separately, put its more specific rule before the general suffix rule.
- GEOIP
- Matches an IP based on its country or region classification in an IP database, not on the domain suffix. The same domain can resolve to different IP addresses and therefore produce different match results. This classification does not indicate the server's precise physical location.
- IP-CIDR
- Describes an IPv4 address range using a network prefix and prefix length. For example,
192.0.2.0/24matches addresses beginning with192.0.2; the number after the slash is not a port. UseIP-CIDR6to match an IPv6 range.
- FINAL
- Specifies how to handle connections not matched by earlier rules and is usually placed at the end of the rule list.
FINAL,DIRECTsends all remaining connections directly to their destinations; it does not change earlier matches to Direct. If traffic unexpectedly hits the fallback, check the preceding conditions and their order.
- PROXY · DIRECT · REJECT
- These are actions applied when a rule matches:
PROXYroutes traffic through a proxy,DIRECTconnects to the destination directly, andREJECTblocks the connection. UppercasePROXYandDIRECTin rules apply only to matching traffic; they are not the same as theProxyandDirectinterface modes.
Subscriptions & Configuration Files
The server list determines which remote endpoints are available; the configuration file determines how connections are handled.
- Server
- A server is the remote endpoint the client connects to. Its entry typically includes the protocol, address, port, and authentication details. If you already have these parameters, add the entry using
Add Server. The display name is just for identification; changing it does not change the connection address.
- Subscription
- A subscription link from a service you already have fetches and updates a set of server entries; add it in the app with
Subscribe. An updated list does not guarantee that every server in it is reachable. Subscription links may contain access credentials, so do not share the full link when troubleshooting.
- Configuration File
- A configuration file stores rules and related settings and commonly uses the
.confextension.[General]contains general settings, while[Rule]contains routing rules. Updating a server subscription does not replace the active configuration; check which file is enabled before troubleshooting routing.
- DNS
- DNS looks up records associated with a domain name and is commonly used to get the IP address needed to connect. A successful lookup only means a record was returned; it does not mean the destination port is reachable. If a domain lookup fails, check the DNS path first. If the domain resolves but requests time out, check the connection path.
- URL Rewrite
- In a configuration,
[URL Rewrite]applies rewrites or redirects based on URL conditions. Routing rules determine which connection path to use; rewrite rules act on the request URL. For encrypted requests, matching a path also depends on whether the app can read the relevant request information.
System Permissions & Installation
Purchase history, system authorization, and in-app settings are managed separately; check each one when moving to a new device.
- VPN Configuration
- The first time you turn on the connection on iPhone or iPad, the system may ask for permission to add a VPN configuration. The system manages this separately from the app's
.conffiles. If you previously denied permission, return to Shadowrocket and try connecting again, then follow the system prompts.
- Purchased Items
- This App Store section lets you view purchase history and redownload eligible apps. When switching devices or reinstalling, first make sure you're signed in to the same store account used for the original purchase. Redownloading the app does not restore server entries or configuration files from purchase history; app data must be transferred separately.
- Apple Silicon and Intel
- Macs use one of two processor architectures. Check the chip or processor name in About This Mac, then choose the matching Mac installer. If macOS blocks the app on first launch, confirm where you got it, then consult the installation guidance to identify the type of warning.
- App ID
- This is the numeric identifier used for an App Store product listing, separate from the account used to make purchases. Shadowrocket's App ID is
932747118; you can verify it at the end of the product page URL. To identify the listing, also check the developer, Shadow Launch Technology Limited, and the official icon—not just the name.