Skip to content

Commit 539b011

Browse files
committed
docs(sharelink): update docs to represent current functionality
1 parent 0614d93 commit 539b011

File tree

1 file changed

+10
-24
lines changed

1 file changed

+10
-24
lines changed

docs/Share-Links.md

+10-24
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,29 @@
11
# Import Share Links
22

33
Aurum supports importing VMessAEAD/VLESS (deprecated), Shadowsocks SIP002 (
4-
via [Shadowsocks.NET](https://github.com/Shadowsocks-NET/Shadowsocks.NET)) and legacy v2rayN base64 share links. This
5-
describes behaviors when importing share links.
4+
via [Shadowsocks.NET](https://github.com/Shadowsocks-NET/Shadowsocks.NET)) and legacy v2rayN base64 share links. This describes behaviors when importing share links.
65

76
## VMessAEAD/VLESS
87

9-
VLESS is considered obsolete and is subject to removal (in the latest `v2ray@5` release), thus Aurum will not actively
10-
support VLESS related functionalities.
8+
In the original v2ray-core, VLESS is considered obsolete, thus Aurum will not include its support in any version prior to `v1` release.
119

12-
VMessAEAD will be the major supported protocol, but there is some subtle difference compared to the VMessAEAD share
13-
links standard proposal:
10+
VMessAEAD will be the major supported protocol, but there is some subtle difference compared to the VMessAEAD share links standard proposal:
1411

15-
- Blank strings for all non-mandatory fields are silently ignored and won't throw error, instead falling back to the
16-
default entry value.
17-
- gRPC's `mode` field is always silently ignored, since none of `v2ray@5` and `sing-box` supports alternative gRPC modes
18-
specified in the share link spec (those modes are proposed mainly by Xray teams).
12+
- Blank strings for all non-mandatory fields are silently ignored and won't throw error, instead falling back to the default entry value.
13+
- gRPC's `mode` field is always silently ignored, since none of `v2ray@5` and `sing-box` supports alternative gRPC modes specified in the share link spec (those modes are proposed mainly by the Xray branch).
1914
- XTLS related field is ignored (as VMess does not support XTLS, and VLESS which supports that is obsolete).
2015

21-
Xray support is undetermined, as XTLS and its successor Reality is a largely incompatible feature which requires VLESS,
22-
a protocol that is considered obsolete for most other implementations. Also, its developer and community had shown
23-
public hostility for some members of the original v2fly community.
16+
Xray support is undetermined, as XTLS and its successor Reality is a largely incompatible feature which requires VLESS, a protocol that is considered obsolete for most other implementations. Also, its developer and community had shown public hostility for some members of the original v2fly community.
2417

2518
## Legacy v2rayN base64 format
2619

27-
The legacy v2rayN base64 share link format support generally follows
28-
the [v2rayN spec (in Chinese)](https://github.com/2dust/v2rayN/wiki/%E5%88%86%E4%BA%AB%E9%93%BE%E6%8E%A5%E6%A0%BC%E5%BC%8F%E8%AF%B4%E6%98%8E(ver-2)),
29-
with the following exceptions:
20+
The legacy v2rayN base64 share link format support generally follows the [v2rayN spec (in Chinese)](https://github.com/2dust/v2rayN/wiki/%E5%88%86%E4%BA%AB%E9%93%BE%E6%8E%A5%E6%A0%BC%E5%BC%8F%E8%AF%B4%E6%98%8E(ver-2)), with the following exceptions:
3021

31-
- None of `v2ray@5` and `sing-box` supports disguise type (other than `http` which is the only available one in TCP)
32-
with KCP and QUIC, thus the `type` field will always be ignored. This might cause you to not be able to connect to
33-
some proxy providers that still uses this feature, please be careful
34-
- Though disguise type other than `http` is always ignored, `host` will still be respected when the transport is TCP or
35-
HTTP (HTTP/2). None of `v2ray@5` and `sing-box` supports custom headers on QUIC and KCP, thus `host` will be ignored
36-
on these transports.
22+
- None of `v2ray@5` and `sing-box` supports disguise type (other than `http` which is the only available one in TCP) with KCP and QUIC, thus the `type` field will always be ignored. This might cause you to not be able to connect to some proxy providers that still uses this feature, please be careful.
23+
- Although disguise type other than `http` is always ignored, `host` will still be respected when the transport is TCP or HTTP (HTTP/2). None of `v2ray@5` and `sing-box` supports custom headers on QUIC and KCP, thus `host` will be ignored on these transports.
3724

3825
## Shadowsocks SIP002 URI Scheme
3926

4027
Shadowsocks SIP002 URI Scheme is fully implemented with the exception of obsolete Stream Ciphers.
4128

42-
Only simple-obfs and v2ray plugins are supported. Simple-obfs is deprecated, though, thus you should consider migrating
43-
to v2ray.
29+
Only simple-obfs and v2ray plugins are supported. Simple-obfs is deprecated, though, thus you should consider migrating to v2ray.

0 commit comments

Comments
 (0)