Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README:add xquic document #1824

Merged
merged 2 commits into from
Jul 24, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 94 additions & 0 deletions modules/ngx_http_xquic_module/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,3 +97,97 @@ http {
```

更为详细的指令可参考官网文档 [XQUIC模块](http://tengine.taobao.org/document_cn/xquic_cn.html)

# 浏览器使用 HTTP3

浏览器默认不会使用 `HTTP3` 请求,需要服务端响应包头 `Alt-Svc` 进行升级说明,浏览器通过响应包头感知到服务端是支持 `HTTP3` 的,下次请求会尝试使用 `HTTP3`。

```nginx
worker_processes 1;

events {
worker_connections 1024;
}

xquic_log "pipe:rollback /usr/local/tengine/logs/tengine-xquic.log baknum=10 maxsize=1G interval=1d adjust=600" info;

http {
xquic_ssl_certificate /usr/local/tengine/ssl/default-fake-certificate.pem;
xquic_ssl_certificate_key /usr/local/tengine/ssl/default-fake-certificate.pem;

server {
listen 2443 xquic reuseport;

location / {
}
}

server {
listen 80 default_server reuseport backlog=4096;
listen 443 default_server reuseport backlog=4096 ssl http2;
listen 443 default_server reuseport backlog=4096 xquic;

server_name s1.test.com;

add_header Alt-Svc 'h3=":443"; ma=2592000,h3-29=":443"; ma=2592000' always;

ssl_certificate /etc/ingress-controller/ssl/s1.crt;
ssl_certificate_key /etc/ingress-controller/ssl/s1.key;
}

server {
listen 80;
listen 443 ssl http2;
listen 443 xquic;

server_name s2.test.com;

add_header Alt-Svc 'h3=":443"; ma=2592000,h3-29=":443"; ma=2592000' always;

ssl_certificate /etc/ingress-controller/ssl/s2.crt;
ssl_certificate_key /etc/ingress-controller/ssl/s2.key;
}
}
```

通过以上配置,浏览器访问对应域名,第一次访问 `HTTP2`,下次访问会切换至 `HTTP3`。

**注意**:

在生产环境中,处于安全性考虑,一般情况会以普通用户权限启动 `Tenigne`,而 `xquic` 功能在普通用户权限下,监听端口必须配置为 1024 以上,如监听 2443 端口,那对外的四层负载均衡需要做 443 到 2443 端口的映射,`Tenigne` `Server`段配置示例:

```nginx
server {
listen 80 default_server reuseport backlog=4096;
listen 443 default_server reuseport backlog=4096 ssl http2;
listen 2443 default_server reuseport backlog=4096 xquic;

add_header Alt-Svc 'h3=":443"; ma=2592000,h3-29=":443"; ma=2592000' always;

ssl_certificate /etc/ingress-controller/ssl/s1.crt;
ssl_certificate_key /etc/ingress-controller/ssl/s1.key;
}
```

四层负载均衡配置示例:

```yaml
type: LoadBalancer
ports:
- port: 80
name: tengine-tcp-80
protocol: TCP
targetPort: 80
- port: 443
name: tengine-tcp-443
protocol: TCP
targetPort: 443
- port: 443
name: tengine-udp-443
protocol: UDP
targetPort: 2443
selector:
app: tengine
```

对用户来讲,还是通过 443 端口访问,通过四层负责均衡设备,转换为 `Tengine` 的 2443 端口。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

负责是否为“负载”的笔误?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

确实笔误,我更新一下文档