Browse Source

docs: adjusted some issues in the document

master v1.3
dnomd343 3 years ago
parent
commit
9bb14f5f22
  1. 10
      README.md
  2. 6
      docs/cdn.md
  3. 11
      docs/setup-docker.md
  4. 6
      docs/setup.md

10
README.md

@ -1,9 +1,7 @@
# echoIP
![license](https://img.shields.io/badge/license-MIT-orange.svg)
![version](https://img.shields.io/badge/version-v1.3-brightgreen.svg)
![total-lines](https://img.shields.io/tokei/lines/github/dnomd343/echoIP)
> 显示客户端IP、查询IP详细信息
@ -23,24 +21,20 @@
```
# 查询客户端IP
shell> curl ip.343.re
···
# 查询客户端UA
shell> curl ip.343.re/ua
···
# 查询客户端IP的详细信息
shell> curl ip.343.re/info
···
# 查询指定IP地址详细信息
shell> curl ip.343.re/8.8.8.8
···
```
![echoIP-cli](https://pic.dnomd343.top/images/X4F.png)
更多使用方法见[命令列表](./docs/cmd-list.md)
更多使用方法见[命令列表](./docs/cmd-list.md)
### 网页访问模式
@ -74,7 +68,7 @@ shell> curl ip.343.re/8.8.8.8
[开发接口](./docs/interface.md)
[上游接口](./docs/upstream.md)
[上游服务](./docs/upstream.md)
## 许可证

6
docs/cdn.md

@ -2,13 +2,11 @@
### 转发原始客户端IP
若HTTP连接中存在 `HTTP_X_FORWARDED_FOR` 参数,echoIP优先选择其作为客户端IP,若不存在该参数则使用与服务器连接的IP地址作为客户端IP。
因此CDN服务器必须在转发时附带该参数,绝大多数情况下CDN服务器会默认在其中填入客户端真实IP,但部分CDN服务商可能会自定义一个额外的参数来存放该数据,这种情况需要修改WEB服务器配置,将该参数内容拷贝到`HTTP_X_FORWARDED_FOR` 中。
若HTTP连接中存在 `HTTP_X_FORWARDED_FOR` 参数,echoIP优先选择其作为客户端IP,若不存在该参数则使用与服务器连接的IP地址作为客户端IP。因此CDN服务器必须在转发时附带该参数,绝大多数情况下CDN服务器会默认在其中填入客户端真实IP,但部分CDN服务商可能会自定义一个额外的参数来存放该数据,这种情况需要修改WEB服务器配置,将该参数内容拷贝到`HTTP_X_FORWARDED_FOR` 中。
若以上配置出错,可能会导致返回IP地址为CDN服务器IP而非客户端IP,在部署并启用CDN服务后务必测试该问题。
### 关闭服务器Gzip压缩
### 关闭服务器GZIP压缩
由于CDN向服务器请求的动态数据较短,压缩效果不大,而静态资源无需持续回源,开启压缩反而浪费服务器资源,因此无需在服务器上配置GZIP压缩,配置示例如下。

11
docs/setup-docker.md

@ -15,12 +15,12 @@ shell> docker --version
使用以下命令安装Docker
```
# Debian系
shell> sudo apt update && sudo apt upgrade
···
# RH系
shell> sudo yum update
···
# Debian系
shell> sudo apt update && sudo apt upgrade
···
# 使用Docker官方脚本安装
shell> sudo wget -qO- https://get.docker.com/ | bash
···
@ -42,15 +42,14 @@ CONTAINER ID IMAGE COMMAND CREATED STATU
48d4b7a644e8 dnomd343/echoip "sh init.sh" 12 seconds ago Created echoip
```
测试容器是否正常工作
如果服务器1601端口未配置防火墙,在浏览器输入 `http://服务器IP:1601/` 即可访问echoIP页面
```
# 测试容器是否正常工作
shell> curl 127.0.0.1:1601/8.8.8.8
···8.8.8.8的详细信息···
```
如果服务器1601端口未配置防火墙,在浏览器输入 `http://服务器IP:1601/` 即可访问echoIP页面
常用容器操作命令
```

6
docs/setup.md

@ -16,7 +16,7 @@ Unpacking objects: 100% ··· done.
### 2. 环境检查
确定你的服务器上有PHP环境、Nodejs环境,同时有 `curl``wget` 工具
确定你的服务器上有PHP环境、Node.js环境,同时有 `curl``wget` 工具
```
shell> php -v
@ -36,7 +36,7 @@ shell> wget --version
```
shell> systemctl | grep fpm
php7.3-fpm.service loaded active running The PHP 7.3 FastCGI Process Manager
php7.3-fpm.service loaded active running The PHP 7.3 FastCGI Process Manager
```
### 3. 运行数据解析服务
@ -148,7 +148,7 @@ server {
}
```
其中PHP-FPM接口在不同系统上不同
其中PHP-FPM接口在系统上不同
```
# RH系一般为本地9000端口

Loading…
Cancel
Save