v2ray / manual Goto Github PK

View Code? Open in Web Editor NEW

887.0 887.0 411.0 11.57 MB

Source code for https://www.v2ray.com/

Shell 10.65% CSS 28.84% HTML 60.51%

manual's People

Contributors

Stargazers

Watchers

Forkers

yorkzhy l-we cool5 netcookies xiliangsong wapdisk zoommt qiujieqiong noscripter flyflypeng tuian xiaokangwang connlan sbilly xgheaven goer99 lambchopinc yandereacg lfyg waylybaye jaelyen taotieren melon neatgz u3shadow wjbviapp wesavetheworld suliuyes nickpeng2 gem7 bytebility code2u anyewuji kindle-rabbit watervip v2to worktimer huxiaori chickenseller pskcore xorryk xiaobingjian oscarinc zhuomingliang machao-github niaojingongcang imooxx u20024804 xkxf1293 kindow qinshulei kenspirit jonasxiao exclm moonwater b81404324df7098a8e021232d7db sherman-liu dancorpse q158073378252010 losesw yohoa wildfire-you gannti xiadao astrataro xrw002 progray baiduerzi work-prjs futureandpast innovativeinventor pelmonf finderl albertroger yujinqiu ariselia billsedison ledudu chaoslazy presleyhank felixonmars cybort lyj55r the0leaner y0umu renzhihui mimi5188 beibei1999 wuxiangzhou2010 nicholaswan eagle51 shoaly sunliang711 wellsmuker jamespan2012 zitiao xcxnig yaspee zuoluo201008 ezioac

manual's Issues

关于页面中命令行参数的疑问。

随着核心版本更新，感觉手册中的命令行参数一节跟不上了，有许多参数没有提到(用户统计、-plugin、-cert等等)，请问可以解决一下吗？谢谢！

Protobuf 配置文档更新

请着手更新v2ray-core项目的Protobuf 配置文档。以便v2ray客户端的更新支持。

请在文档中说明v2ray-core项目对正在使用的JSON配置的处理方式：
v2ray-core项目后续版本是如何对JSON配置文件支持。是不是改为采用第三方程序(如v2ctl)，把JSON格式配置转换为v2ray可执行文件可以使用的Protobuf格式。
v2ray-core项目将来会不会完全废弃JSON配置文件，只单独使用Protobuf配置文件。包括v2ctl也不再转换JSON格式到Protobuf格式。

一个在线生成配置文件的网站

https://www.veekxt.com/utils/v2ray_gen
生成的是4.0+的配置文件……

关于Wiki可能对于一些用户难以理解的几个建议(拙见)

首先我的建议是认为wiki是给用户看的，如果是给开发者看的，当我没说，并且“请在WIKI上说明”
1、建议指明这部分配置的位置或者它所处的嵌套（从配置文件最开始的定位）
因为很多很多的wiki中的配置，仅仅是上面放个大括号，定位到完整配置文件中很难一次定位。
2、参数与参数之间的分隔符是逗号，建议说明一下
3、我有看到每个协议的配置，但是始终没有生成器生成的全面，于是这个能否补充完整？即使不解释每个参数的意义。
4、既然反馈群里每次都有人把https://github.com/KiriKira/vTemplate 发出来为什么不在wiki中体现呢？

V2Ray iOS

i want freelancer project v2ray for iOS. If you can do it, please connect me via email: [email protected]

有关文件安装到了/tmp/v2ray，文档与实际不符

os：ubuntu18.04

关于捐助页

https://www.v2ray.com/chapter_00/02_donate.html
对于单次捐赠的价值超过 $50，您可以从如下选项中指定一项:
为期一个月的首页广告 (您的名字，或 Logo);
按您的喜好修改我们的代码。限制：不可影响用户使用，不可影响文档。您的修改将保留一个月。

关于修改代码，应增加流程说明，以及对匿名和安全的影响的信息。

中文文档中DNS部分有误

zh_cn/chapter_02/04_dns.md
纯字符串: 当此字符串匹配目标域名中任意部分，该规则生效。当此域名完整匹配目标域名时，该规则生效。例如"v2ray.com"匹配"v2ray.com"但不匹配"www.v2ray.com"。

英文文档倒是对的

關於手冊項目的維護工作

@kslr 目前，

兩個站點的內容並不一致，這給維護工作帶來困難。

手冊項目究竟是以 v2ray/manual 還是 v2fly/manual 為準呢？

GPG密钥渲染错误

zh_cn/chapter_00/help.md
https://www.v2ray.com/chapter_00/help.html

此文件中的GPG Key在网站上渲染成了markdown格式（即有了删除线）

https to http redirect for v2ray.com

Hi there!

I was working on something for a project that uses v2ray and noticed there's an issue with the v2ray.com site when redirecting from the root domain (v2ray.com) to the www domain (www.v2ray.com).

When using a go package that uses v2ray.com/core as one of its dependencies, the "go get" command will fail because of this error:

package v2ray.com/core: unrecognized import path "v2ray.com/core" (https fetch: Get http://www.v2ray.com/core/?go-get=1: redirected from secure URL https://v2ray.com/core?go-get=1 to insecure URL http://www.v2ray.com/core/?go-get=1)

Upon closer inspection, it appears when trying to resolve v2ray.com/core, the server returns an HTTP 301 status. However, it does not seem to preserve the protocol (https in this case) when sending the "location" header. As you can see here (output from curl command):

root@server:~# curl -i https://v2ray.com/core?go-get=1
HTTP/1.1 301 Moved Permanently
Date: Sat, 07 Sep 2019 20:09:37 GMT
Content-Type: text/html
Transfer-Encoding: chunked
Connection: keep-alive
Set-Cookie: __cfduid=d4b75de6453f9bd74437d656e18ef702d1567886977; expires=Sun, 06-Sep-20 20:09:37 GMT; path=/; domain=.v2ray.com; HttpOnly; Secure
Location: http://www.v2ray.com/core/?go-get=1
Access-Control-Allow-Origin: *
Expires: Sat, 07 Sep 2019 20:18:36 GMT
Cache-Control: max-age=7200
X-Proxy-Cache: MISS
X-GitHub-Request-Id: D410:1035:207ED:2FFAB:5D73F47C
CF-Cache-Status: HIT
Age: 6661
Strict-Transport-Security: max-age=15552000; includeSubDomains; preload
X-Content-Type-Options: nosniff
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Server: cloudflare
CF-RAY: 512b524a5f88c1cf-IAD

<html>
<head><title>301 Moved Permanently</title></head>
<body>
<center><h1>301 Moved Permanently</h1></center>
<hr><center>nginx</center>
</body>
</html>
root@server:~#

The "Location" header returned by the server is redirecting me to http://www.v2ray.com even though the original request had https in the URL.

Oddly enough, this does not appear to be the behavior when there is a trailing slash in the URL. In the above example, I used https://v2ray.com/core?go-get=1. But when I change the request URL to https://v2ray.com/core/?go-get=1, the server preserves the "https" part of the URL when returning the Location header:

root@server:~# curl -i https://v2ray.com/core/?go-get=1
HTTP/1.1 301 Moved Permanently
Date: Sat, 07 Sep 2019 20:12:30 GMT
Content-Type: text/html
Transfer-Encoding: chunked
Connection: keep-alive
Set-Cookie: __cfduid=d95cf6fce5dfb951a5b098f78559cc7d21567887150; expires=Sun, 06-Sep-20 20:12:30 GMT; path=/; domain=.v2ray.com; HttpOnly; Secure
Location: https://www.v2ray.com/core/index.html?go-get=1
CF-Cache-Status: HIT
Age: 399
Strict-Transport-Security: max-age=15552000; includeSubDomains; preload
X-Content-Type-Options: nosniff
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Server: cloudflare
CF-RAY: 512b5680d87523e8-IAD

<html>
<head><title>301 Moved Permanently</title></head>
<body bgcolor="white">
<center><h1>301 Moved Permanently</h1></center>
<hr><center>nginx/1.10.3</center>
</body>
</html>
root@server:~#

Potential install script command improvement?

Hey there, I've noticed that the documentation suggests the following command to execute installation script:

bash <(curl -L -s https://install.direct/go.sh)

Executing this command without su root in an ssh session yields the following error:

bash: /dev/fd/63: No such file or directory

I was able to bypass this error by running this command instead, still without switching to root user:

curl https://install.direct/go.sh | sudo bash

I was wondering if:

switching to root user is actually mandatory, as it seems to me only a user with sudo privileges suffices;
the second command is preferred over the first, since mine is a straightforward pipe from stdout, and does not need to create virtual files, which might (in my case) create problems over remote sessions.

Thanks for the project, and happy to open a pull request for this!

New Cross-Platform GUI Client for V2Ray

I develop a new GUI client for V2Ray, Shadowsocks, and Trojan, named V2Ray Desktop. It can be used in Windows, Linux, and macOS.
Please consider adding it to 神一样的工具们.

"servers"/"response" 这两对象在配置手册未找到，是何种用途？小白一枚，勿见笑

"settings": {
"vnext": [
],
"servers": null, //用途不知
"response": null //用途不知

Command line wrapper for improving Mac user experience.

https://github.com/jinmiaoluo/v2ray-core-helper
v2ray-core 的Mac命令行客户端. 用于提供类似于 V2rayX 这类软件的Mac图形界面和命令行界面的代理支持

mKcp的说明有误

https://www.v2ray.com/chapter_02/transport/mkcp.html
该页有部分错误

单位应改为MB/s ，默认值到底是多少？

默认只监听了ipv6地址

如图，即使配置了“0.0.0.0” 也只监听了IPv6的地址

一段JSON有误

chapter_03/01_effective.html中“VMess ID” 数量下面的JSON有误，正确写法应该是

"settings": {
"clients": [{
"id": "3b129dec-72a3-4d28-aeee-028a0fe86e22",
"alterId": 100
},
{
"id": "8f62a287-e80a-441f-9f28-affc9fb6c572",
"alterId": 1000
}]
}

Firefox启用DuckDuckGo Privacy Essentials后无法显示www.v2ray.com左侧的导航列表

Firefox64.0在启用DuckDuckGo Privacy Essentials（verson 2018.6.28)这个add-on后，不能显示页面左侧<nav></nav>中的导航目录，浏览器截图如下：

Enabled:

Disabled:

如果没有左侧导航链接，则不能查看网站中除index.html外任何内容。

新安卓V2ray客户端（BifrostV）

建议添加BifrostV到 /ui_client/android.html

下载安装里面的docker地址已经改变

V2Ray 提供了两个预编译的 Docker image：

v2ray/official: 包含最新发布的版本，每周跟随新版本更新；
v2ray/dev: 包含由最新的代码编译而成的程序文件，随代码库更新；

这里的地址似乎已经不再维护
新地址貌似是v2fly/v2fly-core

英文文档对"IPOnDemand"的解释有误.

中文文档是"当匹配时碰到任何基于 IP 的规则，将域名立即解析为 IP 进行匹配",而英文文档是"As long as there is a IP-based rule, V2Ray resolves the domain into IP immediately.", 即:"只要路由规则里面存在IP路由匹配，所有请求的域名都先进行DNS解析"
如图为两种表达代表的规则匹配顺序:

具体来说,v2ray的工作方式是:遍历每一条规则进行匹配,如果在匹配时发现有基于ip的规则,才对待匹配的域名进行解析.
而英文文档表示的意思是:先扫描路由数组有没有IP规则，有则解析后再匹配，没有则直接匹配

可否在文档页面加入搜索功能

提交用户手册中的一个错误

在路由设置中，有

特殊值："geoip:private" (V2Ray 3.5+)

而事实上v2ray至今也才开发到3.23 ，应该是一个手误？

提交一处 typo

https://v2ray.com/developer/intro/compile.html 页面的脚本缺空格

bazel build --action_env=GOPATH=$GOPATH --action_env=PATH=$PATH//release:all

应为

bazel build --action_env=GOPATH=$GOPATH --action_env=PATH=$PATH //release:all

Kitsunebi Lite下架

移除一下吧

邮件地址不存在

开发人员手册->加入方式
中的邮箱[email protected]不存在，无法向其发送邮件。

英文站点部分翻译 2017-03-21

先翻这么多,明天继续~~~
不会玩git,先这么上传吧233
en_20170321.zip

从4.0开始越来越看不懂手册了

4.0开始手册用的Object的Object的Object的方式，看着看着就不知道跑哪里了。请原谅我脑容量比较小，记不住那么多Object名。建议像网页导航那样，在每个分段说明前写个完整路径。例如：

inbounds>
outbounds>

[{
  "tag":"direct",
  "protocol": "http",
  "settings": {},
  "streamSettings": {},
}]


inbounds>streamSettings>kcpSettings
outbounds>streamSettings>kcpSettings

{
  "header": {
    "type": "utp"  // balabala
  }
}

文档在本地编译后，打开 html 文件，里面的链接失效，浏览器无响应

在本地打开编译好的网页 html，只能够打开当前页，里面链接到本地其它网页文件的链接，点击都没有反应。

感觉是最终生成的 html 文件，js 里面 XHR 有点问题。浏览器调试报如下错误：

Access to XMLHttpRequest at 'file:///home/atzlinux/doc/v2ray-manual/publish/chapter_02/protocols/dokodemo.html' from origin 'null' has been blocked by CORS policy: Cross origin requests are only supported for protocol schemes: http, data, chrome, chrome-extension, https.

theme.js:3 GET file:///home/atzlinux/doc/v2ray-manual/publish/chapter_02/protocols/dokodemo.html net::ERR_FAILED

不知道能否修改 js，允许本地流浪网页？

v2ray manual

Help on fa translation

Hi there,
I appreciate the efforts on Persian/fa translation. I see some issues on fa translation and I would be very happy to help on this. Please let me know if there are any considerations or style guide because I couldn't find any contribution guide and I will come back with PRs.

V2ray作者本人去哪里了，这么多个月都不见她的消息了，再怎么藏也藏不起来的，是被请喝茶了吗，大家不去救她的命吗？

4.7的quic的network应该填什么？

{
  "streamSettings": {
    "network": "quic",  // transport 里面没注明，是这样写吗？
    "security": "none",
    "quicSettings": {
      "security": "none",  // stream setting 里面有个security，这里又有个
      "key": "",
      "header": {
        "type": "none"
      }
    }
  }
}

windows版 V2RayGCon项目已删除，请删除相关链接。

如题.

統一中文文案排版

@kslr 目前，無論是手冊還是新白話文教程，由於每個人的寫作風格不同，導致協同維護的結果顯得非常糟糕，我提議使用「中文文案排版指北」作為標準，以提高內容質量。

New Cross-Platform GUI Client for V2Ray

I develop a new GUI client for V2Ray, named V2Ray Desktop.
Please consider adding it to 神一样的工具们.

建议在神一般的工具们里，收录mellow,这是一个横跨MacOS,Linux,Windows的工具

我这MacOS Catalina上使用良好,它解决了v2rayU,v2rayX这样的工具无法在pac模式下对一个应用发出的请求进行分流，如mail。尽管它还很新，但它值得尝试以及它将越来越好。每个稍懂v2ray JSON配置的人都能很好得使用它。

请求更新配置文档

目前配置文档已经和config.json字段不完全匹配了

环境变量v2ray.ray.buffer.size描述有误

https://github.com/v2ray/manual/blob/master/zh_cn/chapter_02/env.md

v2ray.ray.buffer.size描述与实际代码(v3.21 v2ray-core/transport/pipe/pipe.go)有区别，0应为禁止缓存，-1才是无上限

无法访问连接 (https://www.v2ray.com/ui_client/ios.html)

通过google搜索后，发现IOS客户端的连接404，连接是： https://www.v2ray.com/ui_client/ios.html

http outbound 中配置示例有误

      "port": 3128,
      "user": [
        {
          "user": "my-username",
          "pass": "my-password"
        }
      ]

user => users

欢迎随时关闭此issue.

速度测试中的配置有错误

zh_cn/chapter_01/speed.md 中的 测试 V2Ray 的连接速度 小节中, 配置中缺少下面一行:
"listen": "127.0.0.1",

否则的话, 客户端启动 iperf 的的命令应为:
./iperf3 -c 0.0.0.0 -p 8888

在开发者文档中增加示例或推荐默认值

协议部分文档如VMess似乎有点过于简洁，建议适当可以加入一点BestPractice防止开发者误用。许多内容需要二次阅读源码，这对非Golang开发者不是太友好。

一点拙见

http 代理 settings 中的用户等级应与其他协议的用户等级统一为 level　

现在文档中除 http settings 中的用户等级设定外其他协议均为 level，而前者仍为 userlevel，可能会让用户造成混淆，希望能统一

见 https://github.com/v2ray/v2ray-core/blob/master/infra/conf/http.go#L17
https://github.com/v2ray/manual/search?q=userlevel&unscoped_q=userlevel

Actinium下架了

安卓客户端章节中Actinium中play store的下载链接失效了。

hope it could support subscribe.

Hope it could support subscribe. Have you, the honored developer, got a plan for it?

iran

    "loglevel": "warning",
    "access": "/var/log/v2ray.access.log",
    "error": "/var/log/v2ray.error.log"
    "loglevel": "warning",
    "access": "/var/log/v2ray.access.log",
    "error": "/var/log/v2ray.error.log" [Warning] v2ray.com/core: V2Ray

Consideration for adding a new GUI for V2Ray

Hi V2Ray development members, recently I just developed a software called Trojan-Qt5. Originally it was oriented for trojan only, but now supported V2Ray as well.
The link is here => https://github.com/Trojan-Qt5/Trojan-Qt5

Let me describe some features:

No V2Ray-Core install required, integrated with core.dll(so)
User Friendly GUI Interface

Thanks for consideration!

At least 300 stars
not use "V2Ray" directly to prevent misunderstanding