Official Manual · Glossary

Shadowrocket Glossary

Look up interface terms, protocols, and rule keywords by meaning. First distinguish match conditions, action policies, and connection parameters, then change the relevant setting.

  • Keep English interface labels as written
  • Five glossary categories
  • Link to any term with its anchor

Check where a term appears

The same English term can refer to different things at different levels. For example, Config can mean the config management screen or an option under Global Routing; Proxy is an interface option, while PROXY commonly appears as a rule policy. To identify the meaning, check the screen, nearby fields, and active config—not just the term itself.

This page explains concepts; it does not replace step-by-step instructions. For your first import, read the user guide. To check options such as DNS, On Demand, Ping, and Log, see the settings reference. Menu locations may vary by platform, so the terms below do not imply that every platform has the same interface layout.

INTERFACE & SWITCHES

Interface & Toggles

First identify whether a toggle controls the overall connection, routing choice, or diagnostic behavior. Turning on the connection does not mean every request will use the same route.

Global Routing
A setting that controls the overall routing mode. The common options are Config, Proxy, and Direct. Config processes requests according to the active config's rules; Proxy and Direct select an overall proxy or direct connection mode. If custom rules do not work, first check that Config is selected here, then inspect the rules.
Config / Proxy / Direct
These are the three interface options in Global Routing, not server names. Config routes traffic according to the config, Proxy uses a proxy route, and Direct connects directly. They are at a different level from the uppercase PROXY and DIRECT policies in rule entries. When reporting an issue, include the screen where the option appears.
On Demand
A feature that lets the system start a VPN connection when preset conditions are met, useful for managing connections based on network conditions. It is neither a rule list nor a protocol. After changing it, check what happens when switching networks, resuming from a locked screen, and disconnecting manually so that an automatic reconnect is not mistaken for a faulty toggle.
DNS
DNS resolves domain names to IP addresses and is an important part of accessing a domain. A successful DNS lookup only confirms that an address was returned; routing, server status, or protocol settings can still prevent a connection. If a latency test succeeds but a site will not load, check the DNS result and connection logs separately. Avoid changing every DNS field at once.
Connectivity Test
A test for whether a specified connection path is reachable. Results depend on the test method and target; a successful test does not prove that every site, protocol, and rule is working. To compare results, use the same test method on the same network. If a test fails, check Log to see whether the failure occurred during DNS resolution, connection setup, or a later request.
Ping
Usually refers to the response time for a probe, but the exact measurement depends on the selected test method. A lower value does not mean faster downloads or guarantee a stable long-lived connection. Assess real-world performance using app access, repeated tests, and network changes. Do not change the entire config based on a single test.
Log
A view of connection and diagnostic records that can help pinpoint DNS failures, connection errors, or rule matches. Note the time, then reproduce the issue once to correlate records with the request. Before sharing logs, check for server addresses, subscription links, identities, and other sensitive fields; share only what is needed to diagnose the problem.

PROTOCOLS

Protocols

A protocol name identifies the technology used for a connection; it does not mean the connection settings are complete. Use the server details you already have to configure the type, identity, transport, and security layers.

Shadowsocks
A proxy protocol that commonly requires a server address, port, password, and encryption method. The client and server must use matching settings; entering the correct address and password alone may not be enough. Check any additional options in your provider's details rather than copying settings from another record.
VMess
A proxy protocol that uses an identity along with transport settings. In addition to the server address, port, and identity, settings may include transport type, path, Host, and TLS parameters. If the connection fails after import, check that the full set of settings belongs to the same server record instead of checking only the identity.
VLESS
A proxy protocol that uses transport-layer and security-layer settings; the identity is only one part of the connection details. It is not interchangeable with VMess. Even if the fields look similar, do not reuse a record by changing only the protocol type. Check the full details provided by your service provider, including transport, security layer, and server name.
Trojan
A proxy protocol that typically uses TLS. Common connection details include the server address, port, password, and server name. Certificate errors and password errors have different causes and should be checked separately. If TLS fails, check the system time, server name, and certificate details first; do not routinely bypass certificate validation.
Hysteria2
A QUIC-based proxy protocol whose connection behavior depends on UDP availability on the current network. Authentication, TLS, and any other parameters explicitly provided in your connection details must match the server. If it fails on one network but works on another, compare network conditions using the same settings rather than assuming the server record is wrong.
WireGuard
A protocol that creates a tunnel using public and private keys and Peer settings. Common terms include interface address, peer public key, Endpoint, and Allowed IPs. A successful handshake does not guarantee that routing and DNS are correct for every destination. The private key is sensitive; do not share it or a QR code containing it when troubleshooting.
HTTP / SOCKS5
Two proxy protocol names. Use the one that matches the server endpoint you have. The protocol name alone does not mean traffic between the client and proxy server is encrypted, and a website using HTTPS does not determine the proxy endpoint's protocol. Check the address, port, authentication requirements, and capabilities explicitly supported by the server.

RULE KEYWORDS

Rule Keywords

The first part of a rule specifies what to match; the policy specifies what to do when it matches. Check the match scope first, then the rule order, and finally confirm that the referenced policy exists.

Rules
A config entry made up of a match condition and an action policy. Rules are usually checked from top to bottom, and matching stops at the first hit. For example, DOMAIN-SUFFIX,example.com,PROXY contains a keyword, match value, and policy. Put more specific conditions before broader ones to prevent an earlier rule from matching first.
DOMAIN / DOMAIN-SUFFIX / DOMAIN-KEYWORD
DOMAIN matches an exact domain, DOMAIN-SUFFIX matches a domain and its subdomains, and DOMAIN-KEYWORD matches a keyword contained in a domain. Their scopes differ; these are not abbreviations of the same match. When the target is known, use the most precise condition available to avoid affecting unrelated domains.
IP-CIDR / IP-CIDR6
These keywords match IPv4 and IPv6 address ranges. The prefix length after the slash determines the range; for example, 192.168.0.0/16 is an IPv4 range. IP rules and domain rules use different criteria. Check the target address, DNS result, and any earlier matching rules to understand the actual result.
GEOIP
A rule keyword that matches against an IP geolocation database. Results depend on the database contents and how recently it was updated. It does not determine a match from a webpage's language, domain suffix, or the user's location. For services using a CDN or shared infrastructure, check the actual destination IP instead of inferring the result from the site name.
FINAL
The fallback rule used when none of the preceding rules match, usually placed at the end of the rule list. For example, FINAL,DIRECT sends unmatched requests to DIRECT. It determines how otherwise-unmatched traffic is handled, so before changing it, check which requests will reach this rule. FINAL is not a switch that fixes every connection problem.
PROXY / DIRECT / REJECT
PROXY applies a proxy policy, DIRECT connects directly, and REJECT rejects the request. These are action policies, not domains, protocols, or server addresses. The route ultimately used by PROXY depends on the active config and selection. Custom policy names must also have a corresponding definition in the config.
USER-AGENT
A rule keyword that matches User-Agent information in a request, provided the current traffic path can read it. Information hidden in encrypted traffic cannot be matched simply by adding a rule. This is not a reliable way to identify every app; first confirm that the request and current feature conditions make the information available.

SUBSCRIPTION & CONFIG

Subscriptions & Configs

Subscriptions provide and update service details; configs organize rules and related settings. Successful import, successful subscription update, and a working connection are three separate things to verify.

Subscribe
An entry point for importing or updating subscription content. Get subscription links from your service provider. A subscription can contain multiple server records, unlike a link for a single server, and may not include a complete routing config. Subscription URLs may contain access credentials; avoid sharing the full link in screenshots, support requests, or elsewhere.
Add Server / SERVER
Add Server creates a single server record. SERVER fields contain the corresponding server details. A record typically includes a protocol, address, port, and authentication parameters—not just a name. Manual entry is for when you have the complete parameters. If you only have a subscription link, use the subscription entry point instead of pasting the link into the server address field.
Config
As a config management screen, Config organizes the active rules, policy references, and other config content. Saving a file here does not necessarily mean it is selected or enabled; check whether the config is present and whether it is active. This is different from Config in Global Routing, which means routing according to the current config.
Scan QR Code
An entry point for importing config data from a QR code. The QR code is only a way to carry information and cannot fill in missing parameters. The same kind of code may contain a single server link, a subscription URL, or other data; check the decoded result and its source before importing. A successful scan does not guarantee a working connection. Do not share QR codes that contain authentication details.
URL Rewrite
A feature that rewrites request URLs or performs related redirects based on match conditions. This is different from routing rules, which determine the path a request takes. It cannot replace DOMAIN-SUFFIX or FINAL and is not a general fix for DNS failures. Before using it, understand the match scope and traffic visibility, then test it on one item to check for unintended effects on other requests.
iCloud Sync
Syncs supported data across eligible devices through iCloud. The available sync options determine what is included. This is separate from updating a provider subscription and from restoring store purchases. If data does not appear, check the iCloud account, sync toggle, network connection, and the specific item waiting to sync.

PACKAGES & PLATFORMS

Packages & Platforms

Check the operating system and processor type before choosing how to get the app. Installers for other platforms are available on this site under /dl/shadowrocket/; see the download page for links.

.deb / .rpm / .AppImage
Common Linux package formats. Choose based on your distribution, package manager, and system environment—not file size. .deb is commonly used by Debian-based distributions, while .rpm is used by distributions that manage RPM packages. An .AppImage may need executable permission before you check its runtime dependencies. See the installation instructions; do not mix commands for different package formats.
Apple silicon / Intel
Check the processor type when choosing a Mac installer; find it under “About This Mac.” Shadowrocket provides separate .dmg installers for Apple silicon and Intel Macs, so do not rely on the computer's appearance or purchase year. If you see “Apple cannot verify the developer” on first launch, confirm the source, then follow the installation instructions under “Privacy & Security.”
App Store / Purchased
The App Store is where you get Shadowrocket for iPhone and iPad. To download it again, look under Purchased using the account that made the original purchase. Confirm the developer, Shadow Launch Technology Limited, the official app icon, and app ID 932747118. System requirements are as listed on the App Store page. The iPhone and iPad version costs $2.99 as a one-time App Store purchase; the Mac, Windows, Android, and Linux versions are free.
Client and proxy service
The client handles proxy connections, rule-based routing, and local settings. A proxy service provides connectable servers and authentication details; these are separate things. A one-time client purchase does not include a proxy service plan, and you must check that your server or subscription is still valid. For subscription updates, account status, or server maintenance, refer to information from your service provider.

Keep reading by topic

For step-by-step instructions, see the user guide. To check settings one by one, see the settings reference. Find installers and store links on the all-platform downloads page. If a connection fails after import, keep the current settings and first record the test results and error details. Troubleshoot one item at a time to avoid making the cause harder to identify.