upload_progress_header
upload_progress_header 指令设置用于报告上传进度的 HTTP 头的名称。
NGINX upload progress tracking module
·
httpserverlocation
语法upload_progress_header header_name;
默认值none
上下文http, server, location
参数1
说明
upload_progress_header 指令用于指定在文件上传过程中向客户端报告上传进度时使用的 HTTP 头的名称。该头很重要，因为它允许客户端脚本实时跟踪上传操作的进度。该模块通过唯一标识符记录上传进度，并使用指定的头向客户端提供关于上传当前状态的更新，例如已上传的量和剩余的量。
该指令可以放在 'http'、'server' 或 'location' 上下文中，这意味着它可以应用于整个 server 块、特定的服务器或特定的位置，从而允许针对不同路由和资源的灵活配置。期望的值是一个表示头名称的字符串。例如，常见用法可能是 'X-Upload-Progress'，允许客户端的 JavaScript 监听该头并相应地更新用户界面。
在配置此指令时，应注意指定的头名称不得与应用程序已使用的现有头或其他模块或配置可能需要的头发生冲突。此外，确保在管理上传的应用程序逻辑中对该头进行正确处理，以便它能够有效地将上传状态传达给客户端。
配置示例
server {
location /upload {
upload_progress_header X-Upload-Progress;
...
}
}⚠
请确保所指定的 header name 不会与现有的 HTTP headers 冲突。
⚠
进度跟踪只有在 uploads 已正确配置并通过 upload_progress directive 跟踪时才会生效。
⚠
如果客户端未正确处理所指定的 header，可能会导致对 upload state 的混淆。