01 · Share links and subscription content

A share link describes a profile; a subscription URL retrieves and updates a collection. Listed protocols include VMess, Shadowsocks, SOCKS, VLESS, Trojan, Hy2, TUIC, WireGuard and AnyTLS. Content may contain standard links, Base64-wrapped link lists or internal v2rayN links.

A normal web page is not subscription data. Login/error pages cannot be parsed. Preserve the provider’s complete subscription URL, including its path and query.

02 · Add and update a subscription

Create a subscription group with a recognizable label, paste the complete URL into its address field, save and update. Open the resulting group and activate a profile.

  1. With no working proxy, try the direct update command; with a working profile, try updating through it.
  2. Enable updates for the group; disabled groups are skipped.
  3. Check download and parsing logs. Successful updates clear old latency and speed results.
  4. If the active profile belongs to the group, it is processed again; test the connection afterward.
Filters, merging and requests

03 · Internal link structure

Internal links preserve fields not fully represented by standard links. ConfigType identifies the profile type; the payload is JSON encoded as URL-safe Base64. Base64 does not protect passwords.

These links are intended for v2rayN; other clients may not support them. Preserve the prefix and payload, including URL-safe - and _ characters.

Internal share formatCopy
v2rayn://<ConfigType>/<URL-safe Base64 JSON>

04 · JSON payload and references

A standard payload contains type/version, label, address, port and protocol credentials. IndexId may be empty; groups or chains that reference profiles need stable, unique identifiers.

This HTTP profile demonstrates structure only. The domain and credentials are placeholders. The encoded payload still contains credentials.

JSON · illustrative HTTP profileCopy
{
  "IndexId": "example-http",
  "ConfigType": 10,
  "ConfigVersion": 4,
  "Remarks": "Example HTTP",
  "Address": "example.com",
  "Port": 8080,
  "Username": "example-user",
  "Password": "replace-me"
}

05 · Groups and dynamic selection

Groups can reference IndexId values through ProtoExtraObj.ChildItems. SubChildItems=self with Filter selects aliases from the same subscription group. Custom configurations are excluded from the internal format.

Subscription updates can replace profiles and invalidate manual selections. Use group/alias filters for membership that follows updates; reserve manual selections for stable, individually managed profiles. Chain order follows actual traffic direction.

Policy groupsProxy chains

06 · Downloaded but no profiles appear

Check that the response is supported data, not a page, challenge or access error, then check whether an alias filter removed everything. Merged subscriptions must use compatible content types. Providers may vary output by User Agent; keep the default unless a specific value is required.

Correct the URL, format or filter before updating again. A single share link can help isolate parsing from subscription retrieval.

07 · Subscription group fields

Groups can separate sources or merge compatible content. Save and update to apply filtering and request settings.

FieldBehavior
Address / additional addressesPrimary URL plus comma-separated extras; compatible formats required; extras disable conversion
Alias regex filterKeep matching labels after parsing; check the expression if results are empty
Conversion targetRetrieve converted data from a conversion service; disabled for merged URLs
User AgentDefaults to v2rayN/version and may influence the returned format
Custom HTTP headersAdded in 7.25.6; use provider-required headers and keep credentials private
Upstream / landing aliasReference a unique existing profile name
Custom Socks portPropagated to custom configurations parsed from this subscription

08 · Backup and restore

Backups include guiConfigs: settings, profile database and custom configurations. Save a ZIP through Backup and restore; explicitly use a zip extension on non-Windows systems, where the restore picker accepts ZIP files.

Restore replaces relevant data and restarts the client, so back up the current state first. Reopen manually if restart fails. Backups contain credentials; keep them in controlled storage and check local paths/core binaries after migration.

SourceOfficial documentation

Steps and parameters are provided on this page. The reference identifies the source. Reviewed 2026-10-19.