Skip to content

Commit

Permalink
add global configuration doc
Browse files Browse the repository at this point in the history
  • Loading branch information
addozhang committed Oct 10, 2023
1 parent e407e1f commit 3778fcf
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 2 deletions.
34 changes: 34 additions & 0 deletions content/zh-cn/features/global-configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: "全局配置"
description: "介绍 FGW 的全局配置,控制 FGW 的核心行为和处理流程"
weight: 1
draft: false
---

## 介绍

全局配置项是用来管理和调整 FGW 的核心行为和处理流程,这些配置能在 FGW 的各个功能和模块中被应用,支持如日志管理、网络超时设置、请求处理和健康检查等各种全局行为的定制化设置。

## 配置说明

下面是对[全局配置](/reference/configuration/#1-全局配置configs)的详细说明:

- `EnableDebug`:激活或禁用调试日志输出。当此选项设置为 `true` 时,系统将记录详细的调试信息,这对于开发和故障排查非常有价值。需要注意的是,持续的日志记录可能会对系统性能产生影响。

- `StripAnyHostPort`:控制是否剥离 HTTP 请求头中 Host 字段的端口信息。当此项为 `true` 时,例如,`Host: www.aaa.com:8080` 会被视作 `Host: www.aaa.com`,这有助于简化主机名的处理和路由。

- `DefaultPassthroughUpstreamPort`:在 [TLS 透传](/features/tls/passthrough/) 模式中,默认使用此端口号来转发流量,尤其是在上游服务器端口未被明确指定的情况下。它有助于确保在缺乏详细配置信息的情况下,流量能够被正确转发到目标。

- `SocketTimeout`:定义网络 socket 操作的超时时长,单位为 ****,默认值是 **60**。这是系统等待网络响应的最大时间阈值,通过这一设置可以防止网络问题导致的资源挂起。

- `PidFile`:指定一个文件路径,系统将在此文件中写入 Pipy 进程的 ID。这在进行进程管理和监视时可能会非常有用。

- `ResourceUsage`:控制是否收集及如何收集 Pipy 进程的资源使用数据,如 CPU 使用率和内存消耗。这些数据可用于监视系统的健康状态和进行性能优化。

- `HealthCheckLog`:确定如何记录和存储系统的健康检查日志。该设置指定了存储这些日志的服务器或存储解决方案的详细信息。

- `Gzip`:包含控制如何压缩静态文本文件的参数。这些设置影响如何对静态内容应用 Gzip 压缩,有助于减少传输的数据量和提高响应速度。

- `ProxyRedirect`:定义了如何重写上游服务器在 HTTP 响应(例如 Location 或 Refresh 头)中的 URL。这允许在必要时修改重定向 URL,以确保它们满足下游客户端的需求。

- `ErrorPage`:允许为特定的 HTTP 错误代码定义定制的错误页面或链接。当 FGW 检测到定义的错误代码时,它将返回与之关联的自定义页面或链接,以提供更丰富或友好的错误信息。
2 changes: 1 addition & 1 deletion content/zh-cn/features/http-load-balancer/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "HTTP/HTTPS 负载均衡"
description: "L7 负载均衡功能可以对更高级别的网络协议(如 HTTP、HTTPS)进行有效的负载均衡。本文档将介绍如何使用 FGW 的 L7 负载均衡功能。"
weight: 2
weight: 3
---

## 介绍
Expand Down
2 changes: 1 addition & 1 deletion content/zh-cn/features/tcp-load-balancer/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "TCP 负载均衡"
description: "本文档将介绍如何配置 FGW 代理和负载均衡 TCP 流量。"
weight: 1
weight: 2
---

## 介绍
Expand Down

0 comments on commit 3778fcf

Please sign in to comment.