Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
snail007 committed Apr 13, 2024
1 parent 2cff7ba commit ff5107e
Show file tree
Hide file tree
Showing 8 changed files with 34 additions and 24 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2098,13 +2098,16 @@ each client connection.
1. By default, `--auth-url` is required to provide the user name and password. If you do not need the client to provide the username and password, and authenticate, you can add `--auth-nouser`. The visit will still access the authentication address `--auth-url` for authentication. Only the $user authentication username and the $pass authentication password received in the php interface are empty when client didn't send username and password.
2. Connection limit priority: User authentication file limit - "File ip.limit limit -" API user limit - "API IP limit -" command line global connection limit.
3. Rate Limit Priority: User Authentication File Rate Limit - "File ip.limit Rate Limit -" API User Rate Limit - "API IP Rate Limit - "Command Line Global Rate Limit.
3. The upstream obtains the priority: the upstream of the user authentication file - the file ip.limit upstream-"API upstream-" command line specifies the upstream.
4.`--auth-cache` authentication cache, cache the authentication result for a certain period of time, improve performance, reduce the pressure on the authentication interface, --auth-cache unit seconds, default 0, set 0 to close the cache.
4. The upstream obtains the priority: the upstream of the user authentication file - the file ip.limit upstream-"API upstream-" command line specifies the upstream.
5. `--auth-cache` authentication cache, cache the authentication result for a certain period of time, improve performance, reduce the pressure on the authentication interface, --auth-cache unit seconds, default 0, set 0 to close the cache.
6. By default, `--auth-cache` only caches the results of successful authentication and does not cache the results of failed authentication. If you need to cache the failed authentication results for a certain period of time,
It can be set through the parameter `-auth-fail-cache` to improve performance and reduce the pressure on the authentication interface. The unit of --auth-fail-cache is seconds. The default is 0. Setting 0 turns off the cache.

#### upstream detailed description

1. When the parameter `sps` is 0.
When the service is http, upstream only supports http(s) proxy, and does not support authentication. If authentication is required, it can be replaced by sps. Format:
When the service is http, upstream only supports http(s) proxy, and does not support authentication.
If authentication is required, it can be replaced by sps. Format:
`http://127.0.0.1:3100?argk=argv`
When the service is a socks, the upstream only supports the socks5 proxy. The format is:
`socks5://127.0.0.1:3100?argk=argv`
Expand Down
10 changes: 6 additions & 4 deletions README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -2116,7 +2116,7 @@ proxy的http(s)/socks5/sps代理功能,支持通过API控制用户对代理对

#### 具体使用

proxy的http(s)/socks5/sps代理API功能,通过`--auth-url``--auth-nouser``--auth-cache`三个参数控制
proxy的http(s)/socks5/sps代理API功能,通过`--auth-url``--auth-nouser``--auth-cache``--auth-fail-cache`4个参数控制
参数`--auth-url`是HTTP API接口地址,客户端连接的时候,proxy会GET方式请求这url,带上下面参数,如果返回HTTP状态码204,代表认证成功,其它情况认为认证失败。

一个完整的请求API的示例:
Expand Down Expand Up @@ -2220,12 +2220,14 @@ if($ok){

#### 提示

1. 默认情况下,设置了`--auth-url`是强制要求客户端提供用户名和密码的;如果不需要强制要求客户端提供用户名密码,并认证,可以加上`--auth-nouser`每次访问仍然会访问认证地址`--auth-url`
进行认证,当客户端没有发生认证信息当时候,php接口里面接收的$user认证用户名和$pass认证密码都为空。
1. 默认情况下,设置了`--auth-url`是强制要求客户端提供用户名和密码的;如果不需要强制要求客户端提供用户名密码,并认证,可以加上`--auth-nouser`
每次访问仍然会访问认证地址`--auth-url`进行认证,当客户端没有发生认证信息当时候,php接口里面接收的$user认证用户名和$pass认证密码都为空。
2. 连接数限制优先级:用户认证文件连接数限制-》文件ip.limit连接数限制-》API用户连接数限制-》API的IP连接数限制-》命令行全局连接数限制。
3. 速率限制优先级:用户认证文件速率限制-》文件ip.limit速率限制-》API用户速率限制-》API的IP速率限制-》命令行全局速率限制。
4. 上级获取优先级:用户认证文件的upstream-》文件ip.limit的upstream-》API的upstream-》命令行指定的上级。
5. `--auth-cache`认证缓存,对认证结果缓存一定时间,提升性能,降低认证接口压力,--auth-cache 单位秒,默认0, 设置0是关闭缓存。
5. `--auth-cache`认证成功缓存,对认证成功结果缓存一定时间,提升性能,降低认证接口压力,--auth-cache 单位秒,默认0, 设置0是关闭缓存。
6. 默认情况下`--auth-cache`只缓存认证成功的结果,对认证失败的结果不缓存,如果需要缓存失败的认证结果一定时间,
可以通过参数`-auth-fail-cache`设置,提升性能,降低认证接口压力,--auth-fail-cache 单位秒,默认0, 设置0是关闭缓存。

#### upstream详细说明

Expand Down
9 changes: 6 additions & 3 deletions docs/manual/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -1890,13 +1890,16 @@ each client connection.
1. By default, `--auth-url` is required to provide the user name and password. If you do not need the client to provide the username and password, and authenticate, you can add `--auth-nouser`. The visit will still access the authentication address `--auth-url` for authentication. Only the $user authentication username and the $pass authentication password received in the php interface are empty when client didn't send username and password.
2. Connection limit priority: User authentication file limit - "File ip.limit limit -" API user limit - "API IP limit -" command line global connection limit.
3. Rate Limit Priority: User Authentication File Rate Limit - "File ip.limit Rate Limit -" API User Rate Limit - "API IP Rate Limit - "Command Line Global Rate Limit.
3. The upstream obtains the priority: the upstream of the user authentication file - the file ip.limit upstream-"API upstream-" command line specifies the upstream.
4.`--auth-cache` authentication cache, cache the authentication result for a certain period of time, improve performance, reduce the pressure on the authentication interface, --auth-cache unit seconds, default 0, set 0 to close the cache.
4. The upstream obtains the priority: the upstream of the user authentication file - the file ip.limit upstream-"API upstream-" command line specifies the upstream.
5. `--auth-cache` authentication cache, cache the authentication result for a certain period of time, improve performance, reduce the pressure on the authentication interface, --auth-cache unit seconds, default 0, set 0 to close the cache.
6. By default, `--auth-cache` only caches the results of successful authentication and does not cache the results of failed authentication. If you need to cache the failed authentication results for a certain period of time,
It can be set through the parameter `-auth-fail-cache` to improve performance and reduce the pressure on the authentication interface. The unit of --auth-fail-cache is seconds. The default is 0. Setting 0 turns off the cache.

#### upstream detailed description

1. When the parameter `sps` is 0.
When the service is http, upstream only supports http(s) proxy, and does not support authentication. If authentication is required, it can be replaced by sps. Format:
When the service is http, upstream only supports http(s) proxy, and does not support authentication.
If authentication is required, it can be replaced by sps. Format:
`http://127.0.0.1:3100?argk=argv`
When the service is a socks, the upstream only supports the socks5 proxy. The format is:
`socks5://127.0.0.1:3100?argk=argv`
Expand Down
10 changes: 6 additions & 4 deletions docs/manual/zh/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -1877,7 +1877,7 @@ proxy的http(s)/socks5/sps代理功能,支持通过API控制用户对代理对

#### 具体使用

proxy的http(s)/socks5/sps代理API功能,通过`--auth-url``--auth-nouser``--auth-cache`三个参数控制
proxy的http(s)/socks5/sps代理API功能,通过`--auth-url``--auth-nouser``--auth-cache``--auth-fail-cache`4个参数控制
参数`--auth-url`是HTTP API接口地址,客户端连接的时候,proxy会GET方式请求这url,带上下面参数,如果返回HTTP状态码204,代表认证成功,其它情况认为认证失败。

一个完整的请求API的示例:
Expand Down Expand Up @@ -1981,12 +1981,14 @@ if($ok){

#### 提示

1. 默认情况下,设置了`--auth-url`是强制要求客户端提供用户名和密码的;如果不需要强制要求客户端提供用户名密码,并认证,可以加上`--auth-nouser`每次访问仍然会访问认证地址`--auth-url`
进行认证,当客户端没有发生认证信息当时候,php接口里面接收的$user认证用户名和$pass认证密码都为空。
1. 默认情况下,设置了`--auth-url`是强制要求客户端提供用户名和密码的;如果不需要强制要求客户端提供用户名密码,并认证,可以加上`--auth-nouser`
每次访问仍然会访问认证地址`--auth-url`进行认证,当客户端没有发生认证信息当时候,php接口里面接收的$user认证用户名和$pass认证密码都为空。
2. 连接数限制优先级:用户认证文件连接数限制-》文件ip.limit连接数限制-》API用户连接数限制-》API的IP连接数限制-》命令行全局连接数限制。
3. 速率限制优先级:用户认证文件速率限制-》文件ip.limit速率限制-》API用户速率限制-》API的IP速率限制-》命令行全局速率限制。
4. 上级获取优先级:用户认证文件的upstream-》文件ip.limit的upstream-》API的upstream-》命令行指定的上级。
5. `--auth-cache`认证缓存,对认证结果缓存一定时间,提升性能,降低认证接口压力,--auth-cache 单位秒,默认0, 设置0是关闭缓存。
5. `--auth-cache`认证成功缓存,对认证成功结果缓存一定时间,提升性能,降低认证接口压力,--auth-cache 单位秒,默认0, 设置0是关闭缓存。
6. 默认情况下`--auth-cache`只缓存认证成功的结果,对认证失败的结果不缓存,如果需要缓存失败的认证结果一定时间,
可以通过参数`-auth-fail-cache`设置,提升性能,降低认证接口压力,--auth-fail-cache 单位秒,默认0, 设置0是关闭缓存。

#### upstream详细说明

Expand Down
10 changes: 5 additions & 5 deletions docs/sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,31 +18,31 @@
</url>

<url>
<loc>https://snail007.goproxyauth.com/goproxy/tags/cdn/</loc>
<loc>https://snail007.goproxyauth.com/goproxy/categories/</loc>
<lastmod>2019-07-05T08:20:48+08:00</lastmod>
<priority>0</priority>
</url>

<url>
<loc>https://snail007.goproxyauth.com/goproxy/categories/</loc>
<loc>https://snail007.goproxyauth.com/goproxy/</loc>
<lastmod>2019-07-05T08:20:48+08:00</lastmod>
<priority>0</priority>
</url>

<url>
<loc>https://snail007.goproxyauth.com/goproxy/</loc>
<loc>https://snail007.goproxyauth.com/goproxy/posts/</loc>
<lastmod>2019-07-05T08:20:48+08:00</lastmod>
<priority>0</priority>
</url>

<url>
<loc>https://snail007.goproxyauth.com/goproxy/posts/</loc>
<loc>https://snail007.goproxyauth.com/goproxy/tags/</loc>
<lastmod>2019-07-05T08:20:48+08:00</lastmod>
<priority>0</priority>
</url>

<url>
<loc>https://snail007.goproxyauth.com/goproxy/tags/</loc>
<loc>https://snail007.goproxyauth.com/goproxy/tags/cdn/</loc>
<lastmod>2019-07-05T08:20:48+08:00</lastmod>
<priority>0</priority>
</url>
Expand Down
4 changes: 2 additions & 2 deletions docs/tags/cdn/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<link href="//maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css" rel="stylesheet">
<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css">
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/8.4/styles/solarized_dark.min.css">
<title>CDN - GOPROXY IN ACTION</title>
<title>cdn - GOPROXY IN ACTION</title>

<link href="https://snail007.goproxyauth.com/goproxy/css/styles.css" rel="stylesheet">

Expand Down Expand Up @@ -77,7 +77,7 @@


<header class="page-header">
<h1>CDN</h1>
<h1>cdn</h1>
</header>


Expand Down
4 changes: 2 additions & 2 deletions docs/tags/cdn/index.xml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
<title>CDN on GOPROXY IN ACTION</title>
<title>cdn on GOPROXY IN ACTION</title>
<link>https://snail007.goproxyauth.com/goproxy/tags/cdn/</link>
<description>Recent content in CDN on GOPROXY IN ACTION</description>
<description>Recent content in cdn on GOPROXY IN ACTION</description>
<generator>Hugo -- gohugo.io</generator>
<language>zh-CN</language>
<lastBuildDate>Fri, 05 Jul 2019 08:20:48 +0800</lastBuildDate>
Expand Down
2 changes: 1 addition & 1 deletion docs/tags/index.xml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@


<item>
<title>CDN</title>
<title>cdn</title>
<link>https://snail007.goproxyauth.com/goproxy/tags/cdn/</link>
<pubDate>Fri, 05 Jul 2019 08:20:48 +0800</pubDate>

Expand Down

0 comments on commit ff5107e

Please sign in to comment.