Official Manual · Glossary

Shadowrocket Glossary

Look up interface terms, protocols and rule keywords. First identify the connection target, routing mode and rule action, then change the relevant setting.

This page keeps the original English terms used in the app. Use the link beside any heading to jump directly to that entry. Screens and available options may vary by platform; follow what the app currently displays. For step-by-step instructions, see the getting started guide; for setting details, see the settings manual.

Shadowrocket is available for iPhone, iPad, Mac (Apple silicon and Intel), Windows, Android and Linux. The iPhone and iPad app is a one-time $2.99 purchase on the App Store; the Mac, Windows, Android and Linux versions are free. See the download guide for all platforms for details.

01 · Interface & Controls

Screens & Connection Modes

Screen names identify where an action takes place; mode names determine how requests are handled. Don’t confuse the two.

Home #
Home is the main screen for viewing server entries, choosing a connection and controlling the connection switch. Selecting an entry does not connect by itself; also check the connection switch and system permissions. When troubleshooting, confirm which entry is selected before checking the rules, so a wrong server selection is not mistaken for a configuration issue.
Global Routing #
Global Routing selects the overall routing mode, not a specific server. The options are Config, Proxy and Direct. If rules in a configuration file don’t seem to work, first check that the app is in Config mode, then make sure the file is selected.
Config / Proxy / Direct #
Config handles requests according to the rules in the selected configuration; Proxy uses proxy mode; Direct connects directly. These are overall modes, not the same as the uppercase action keywords in individual rules. Temporarily switching modes can help narrow down an issue; restore the mode you need after testing.
On Demand #
On Demand triggers connection behavior based on conditions such as the network environment. It is useful when connections should start or stop under specific conditions. It controls when a connection is made; it does not determine how requests are routed by domain or IP rules. If a connection keeps coming back on its own, check for a matching On Demand condition instead of repeatedly toggling the main switch.
Add Server #
Add Server is where you create a server entry manually. Choose the protocol based on the server details you already have, then enter the address, port and authentication fields. Don’t guess the protocol based on how the fields look. Saving only confirms that the entry was recorded; test the connection to confirm the details are correct.
Settings #
Settings is where you view and change client options. Settings can affect testing, logs, sync or connection behavior, and not every option is available on every platform. Note the original value before making changes, and change only one setting relevant to the issue at a time so you can assess the result and revert it if needed.

02 · Protocols

Connection Types & Authentication

Protocol names are not speed ratings. The client type, authentication details, transport settings and server configuration must match.

Shadowsocks #
Shadowsocks is a proxy protocol that typically requires a server address, port, password and encryption method. A connection can still fail if the password is correct but the encryption method doesn’t match. When entering details manually, check each field against the original information; don’t use a user ID from another protocol as the password here.
VMess #
VMess uses a user ID and other parameters for authentication; a complete connection may also include transport and security settings. After importing, check the address, port, user ID and related transport fields rather than relying on the entry name. If authentication fails, check the device clock too, as an incorrect time can affect troubleshooting.
VLESS #
VLESS uses a user ID for authentication, but the protocol name itself does not mean transport encryption is enabled. Connection security and compatibility also depend on the associated transport and security settings. Although both use a user ID, VMess and VLESS entries are not interchangeable.
Trojan #
Trojan is commonly used with TLS and requires the correct password and security settings for the server. The server name and certificate verification affect connectivity; entering a server IP does not mean you can ignore the server name field. If you encounter a certificate error, check the domain, device clock and server configuration before considering any change to verification.
Hysteria2 #
Hysteria2 is a QUIC-based proxy protocol that relies on suitable UDP connectivity. UDP reachability on the current network, authentication fields and server settings all affect connection success. Being able to open ordinary webpages does not prove that the network path required by this protocol is working.
WireGuard #
WireGuard creates an encrypted tunnel using public and private keys and peer configuration. Keep the local private key, peer public key, endpoint and address ranges in their respective fields; never swap the key fields. A private key is sensitive: remove it before sharing a configuration or troubleshooting screenshot.
HTTP / SOCKS5 #
HTTP and SOCKS5 are common proxy protocol types; use the one supported by the server. A matching port does not mean the protocols are compatible, and the server determines whether authentication is required. SOCKS5 does not, by its name alone, guarantee encrypted transport, so make sure you understand how the service actually connects.

03 · Rule Keywords

Match Conditions & Actions

Identify what a rule matches, check the action taken when it matches, then review the rule order.

Rule #
A rule typically consists of a match type, match value and action that determine how a request is handled. Rules are generally evaluated in order, so a match earlier in the list may prevent later rules from being checked. After adding a rule, check its position and confirm that Global Routing is set to Config.
DOMAIN / DOMAIN-SUFFIX / DOMAIN-KEYWORD #
DOMAIN matches an exact domain, DOMAIN-SUFFIX matches a domain suffix, and DOMAIN-KEYWORD matches a keyword in a domain. For example, DOMAIN-SUFFIX,example.com,PROXY matches by suffix and sends the request through a proxy. Keyword matches can be broad, so avoid using a short word when a specific domain will do.
GEOIP #
GEOIP matches an IP address using its region in an IP database, for example GEOIP,CN,DIRECT. It does not match based on page content, domain suffix or the visitor’s location. DNS results, the IP database and distributed infrastructure used by a service can all affect the outcome.
IP-CIDR / IP-CIDR6 #
IP-CIDR matches IPv4 ranges; IP-CIDR6 matches IPv6 ranges. The prefix length after the slash defines the range. These rules match IP addresses, not domain names, and the result may change if the destination address changes. For a single address, make sure the prefix doesn’t unintentionally cover a larger range.
FINAL #
FINAL is a fallback rule used when none of the preceding rules match, for example FINAL,PROXY. It usually belongs at the end of the rule list; otherwise, it may handle requests before later rules can be checked. Choose a fallback action that meets your needs rather than trying to override it with more rules placed after it.
PROXY / DIRECT / REJECT #
PROXY sends a request through a proxy, DIRECT connects directly, and REJECT blocks the request. These are rule actions, not protocol names or server addresses. Keep the uppercase forms when reading rules, and distinguish them from the Proxy and Direct modes in Global Routing.
USER-AGENT #
USER-AGENT matches requests using the readable HTTP User-Agent field; it is not the same as routing by app name. This field may not be accessible in encrypted connections, so the presence of a rule does not mean every request can match it. When troubleshooting, check the request conditions and whether the field is visible before changing keywords.

04 · Subscriptions & Configuration

Connection Details, Files & Recovery

Server subscriptions, rule configuration and App Store purchase records manage different things and cannot replace one another.

Subscribe #
Subscribe imports or updates server entries using a subscription URL you already have. An update may change entry details, so distinguish subscription-managed entries from ones you added manually. Subscription URLs may contain access credentials; don’t include them in public screenshots, logs or shared text.
Server entry #
A server entry stores connection details such as the address, port, protocol and authentication, and is sometimes called a node. The entry name is just a label for identification; it doesn’t tell you the actual location, availability or performance. If entries have the same name, check their settings and associated subscription before deleting one, so you don’t remove an entry in use.
Config file #
A Config file can store settings such as rules, DNS or policies. It is different from a subscription that provides server entries. Downloading a file doesn’t mean it has been selected, and editing it doesn’t guarantee the current mode is using it. Config appears both as a screen name and a routing mode; use the context to tell which one is meant.
Scan QR Code #
Scan QR Code reads recognizable connection details from a QR code, which may contain a single server entry or a subscription URL. After scanning, check the detected type and key fields before saving. A QR code is only an encoding format, not a guarantee that its contents are trustworthy. Don’t share codes that contain authentication details.
iCloud sync #
iCloud syncs app-supported data when the relevant account and system permissions are available. Check the app’s documentation for exactly what is included. Turning sync on does not mean all data has finished uploading; verify the restored data on the target device before switching devices. Sync is not a substitute for a separate export backup, so keep a recoverable copy of important configuration.
Purchased items #
Purchased items lets you find your app purchase and restore the download using the account that originally bought it. It does not restore server details or rule files. The iPhone and iPad app is a one-time $2.99 purchase on the App Store; the Mac, Windows, Android and Linux versions are free. The App Store app ID is 932747118, and the developer is Shadow Launch Technology Limited. Check the App Store listing for system requirements.

05 · Settings & Diagnostics

DNS, Tests & Logs

Diagnostic results reflect specific conditions. Assess them alongside the target request, current mode and network environment.

DNS #
DNS resolves domain names to IP addresses. The results can affect subsequent connections and some rule matches. If the server connects but a particular domain doesn’t load, check DNS resolution separately from the route ultimately used by the request. Adding multiple DNS settings without a clear reason makes troubleshooting harder; first confirm which setting the current configuration actually uses.
Connectivity Test / latency #
Connectivity Test checks response under specific test conditions; latency measures how long that process takes. Lower latency does not necessarily mean faster downloads, and a successful test does not guarantee that every request will work. For a meaningful comparison, keep the network, test method and target consistent, then verify with an actual request.
Log #
Log provides runtime records that help identify connection, DNS resolution or request-handling issues. When troubleshooting, note when the issue occurred, the target domain and the current mode, then review the relevant records; this is more useful than an isolated error screenshot. Before sharing, remove subscription URLs, authentication details and any personal browsing records that aren’t needed.
URL Rewrite #
URL Rewrite modifies request URLs or related behavior when matching rules apply. It is separate from choosing proxy or direct routing. Whether it works depends on whether the request can be handled, the matching expression and the relevant configuration. Before changing an expression, confirm its target scope to avoid rewriting requests that should be left alone.
Proxy port #
Proxy port is the local listening port that accepts connections to the proxy service; it is different from the port in a remote server entry. To use it from another program, enter the listening address, port and protocol type. Allowing other devices to connect expands access; check the listener settings, trusted network and access controls before enabling it.
Data #
Data shows traffic recorded by the app; interpret its scope and time period based on the current screen. App-side records may use different accounting from a service provider and should not be treated as the account’s remaining allowance. To investigate unexpected usage, consider the reporting period, connection records and actual activity together.

Back to the steps

For importing details and making your first connection, see the tutorial. For DNS, On Demand and diagnostic options, see the settings manual. For common questions, see Troubleshooting. To check the iPhone and iPad App Store listing, visit the Shadowrocket App Store product page.

Back to glossary categories ↑