完整服务端配置

本页面提供了关于服务器配置文件中每一个字段的详细说明。

注意： 在客户端和服务端配置中的多处都有 "类型选择" 的配置格式：

example:
  type: a
  a:
    something: something
  b:
    something: something
  c:
    something: something

type 用于确定使用哪种模式以及解析哪些子字段。在这个例子中，example 字段可以是 a、b 或 c。如果选择了 a，则会解析 a 子字段，而 b 和 c 子字段则会被忽略。

监听地址

listen 是服务器的监听地址。如果省略，服务器将默认监听 :443 端口，这是 HTTP/3 的默认端口。

listen: :443 # (1)!

当只有端口没有 IP 地址时，服务器将监听所有可用的 IPv4 和 IPv6 地址。要仅监听 IPv4，可以使用 0.0.0.0:443。要仅监听 IPv6，可以使用 [::]:443。

TLS

可以选择使用 tls 或 acme，但不能同时包含两者。

TLSACME

tls: # (1)!
  cert: some.crt
  key: some.key
  sniGuard: strict | disable | dns-san # (2)!

每次 TLS 握手时都会读取证书。可以原地更新证书文件而无需重启服务端。
验证客户端发送的 SNI。与证书信息匹配时才建立连接，否则终止 TLS 握手。
设置为 strict 以启用该功能。
设置为 disable 以禁用该功能。
默认为 dns-san，仅当证书中包含「证书主题背景的备用名称」扩展且该扩展中包含域名时才启用该功能。

acme:
  domains:
    - domain1.com
    - domain2.org
  email: [email protected]
  ca: zerossl # (1)!
  listenHost: 0.0.0.0 # (2)!
  dir: my_acme_dir # (3)!
  type: http | tls | dns # (4)!
  http:
    altPort: 8888 # (5)!
  tls:
    altPort: 44333 # (6)!
  dns:
    name: gomommy # (7)!
    config:
      key1: value1
      key2: value2

要使用的 CA。可以是 letsencrypt 或 zerossl。
用于 ACME 服务器验证的监听地址（不含端口）。默认监听所有可用的地址。
存储 ACME 账户密钥和证书的目录。
ACME 验证类型。请阅读页面最上方关于 "类型选择" 配置格式的说明。
用于 HTTP 挑战的监听端口。（注意：改为非 80 需要另行配置端口转发或者 HTTP 反向代理，否则证书会签署失败！）
用于 TLS-ALPN 挑战的监听端口。（注意：改为非 443 需要另行配置端口转发或者 SNI Proxy，否则证书会签署失败！）
DNS 提供商。详细信息请参考 ACME DNS 配置。

混淆

默认 Hysteria 协议伪装为 HTTP/3。如果你的网络针对性屏蔽了 QUIC 或 HTTP/3 流量（但允许其他 UDP 流量），可以使用混淆来解决此问题。目前有一个名为 "Salamander" 的混淆实现，将数据包混淆成没有特征的 UDP 包。此功能需要一个混淆密码，密码在客户端和服务端必须相同。

注意: 启用混淆将使服务器与标准的 QUIC 连接不兼容，失去 HTTP/3 伪装的能力。

obfs:
  type: salamander # (2)!
  salamander:
    password: cry_me_a_r1ver # (1)!

替换为你的混淆密码。
混淆类型。请阅读页面最上方关于 "类型选择" 配置格式的说明。

QUIC 参数

quic:
  initStreamReceiveWindow: 8388608 # (1)!
  maxStreamReceiveWindow: 8388608 # (2)!
  initConnReceiveWindow: 20971520 # (3)!
  maxConnReceiveWindow: 20971520 # (4)!
  maxIdleTimeout: 30s # (5)!
  maxIncomingStreams: 1024 # (6)!
  disablePathMTUDiscovery: false # (7)!

初始的 QUIC 流接收窗口大小。
最大的 QUIC 流接收窗口大小。
初始的 QUIC 连接接收窗口大小。
最大的 QUIC 连接接收窗口大小。
最长空闲超时时间。服务器会在多长时间没有收到任何客户端数据后关闭连接。
最大并发传入流的数量。
禁用 MTU 探测。

默认的流和连接接收窗口大小分别为 8MB 和 20MB。除非你完全明白自己在做什么，否则不建议修改这些值。如果要改，建议保持流接收窗口与连接接收窗口的比例为 2:5。

带宽

bandwidth:
  up: 1 gbps
  down: 1 gbps

服务器端带宽值的作用是最高速度限制，限制服务器对每个客户端发送和接收的最大速率。注意，服务器上传速度对应的是客户端下载速度，反之亦然。可以选择不写这个字段，或者在一边或两边设为零，零代表没有限制。

支持的单位有：

bps 或 b（每秒比特数）
kbps 或 kb 或 k（每秒千比特）
mbps 或 mb 或 m（每秒兆比特）
gbps 或 gb 或 g（每秒吉比特）
tbps 或 tb 或 t（每秒太比特）

忽略客户端带宽设置

ignoreClientBandwidth: false

ignoreClientBandwidth 启用后，服务器将忽略客户端设置的任何带宽，永远使用传统的拥塞控制算法（目前为 BBR）。

这个功能主要为不希望让用户自己设置带宽的服务器提供。

带宽协商流程

下图展示了在各种配置下，客户端和服务端协商使用何种拥塞控制算法和多大带宽的流程。

graph TD;
    ICB{{"服务端是否配置 ignoreClientBandwidth: true ？"}} -- "是" --> BBR[/"使用 BBR"/];
    ICB -- "否" --> C_has_BW;
    C_has_BW{{"客户端是否配置带宽？"}} -- "否" --> BBR;
    C_has_BW -- "是" --> Brutal;
    Brutal["使用 Brutal"] --> S_has_BW;
    S_has_BW{{"服务端是否配置带宽？"}} -- "否" --> Brutal_C[/"以客户端配置的带宽为准"/];
    S_has_BW -- "是" --> S_C_CMP;
    S_C_CMP{{"比较服务端和客户端配置的带宽"}} -- "服务端更大" --> Brutal_C;
    S_C_CMP -- "客户端更大" --> Brutal_S[/"以服务端配置的带宽为准"/];

    style BBR fill:#dc322f;
    style Brutal fill:#268bd2;
    style Brutal_C fill:#2aa198;
    style Brutal_S fill:#2aa198;

如果你自建 Hysteria 服务器并且只给你自己使用，可以直接删除服务端配置中的 bandwidth 与 ignoreClientBandwidth，使用客户端配置中的 bandwidth 指定带宽，从而将上述流程简化为：

graph TD;
    S_no_BW["`确保服务端 **没有** 配置 bandwidth 与 ignoreClientBandwidth`"] --> C_has_BW;
    C_has_BW{{"客户端是否配置带宽？"}} -- "否" --> BBR[/"BBR"/];
    C_has_BW -- "是" -->  Brutal_C[/"Brutal 且以客户端配置的带宽为准"/];

    style BBR fill:#dc322f;
    style Brutal_C fill:#2aa198;

拥塞控制细节

(本节中的信息是 Hysteria 的内部实现细节，可能会在不同版本之间发生变化)

目前，Hysteria 有两种拥塞控制算法：

BBR： 由 Google 为 TCP 开发，我们对其进行了修改以移植到 QUIC。BBR 是标准的拥塞控制算法，包括慢启动和基于 RTT 变化的带宽估算。BBR 能独立运行，不需要用户手动设置带宽。

Brutal： 这是 Hysteria 自有的拥塞控制算法。与 BBR 不同，Brutal 采用固定速率模型，丢包或 RTT 变化不会降低速度。相反，如果无法达到预定的目标速率，反而会根据计算的丢包率提高发送速率来进行补偿。Brutal 只在你知道（并正确设置了）当前网络的最大速度时才能正常运行。其擅长在拥塞的网络中抢占带宽，因此得名。

Brutal 如果带宽设置低于实际最大值也能正常运行；相当于限速。重要的是不要将其设置得高于实际最大值，否则会因为补偿机制导致连接速度慢、不稳定，且浪费流量。

拥塞控制算法控制的是数据的发送。从客户端的视角，如果没有设置 down 带宽值（但提供了 up），Hysteria 服务器会使用 BBR 向客户端发送数据，但客户端会使用 Brutal 向服务器上传数据，反之亦然。客户端可以提供两者，这样两个方向都会使用 Brutal，或者都不提供，这样两个方向都会使用 BBR。

如上所述，一个特殊情况是当服务器启用了 ignoreClientBandwidth 选项，无论客户端的带宽值如何，双方始终都会使用 BBR。

目前，服务端的带宽限制限制的只是 Brutal 最大速率。因此在使用 BBR 的情况下并不会生效。

速度测试

speedTest: false

speedTest 启用后，服务端将允许客户端进行下载和上传速度测试。详细信息请参考速度测试文档。

UDP

disableUDP: false

disableUDP 启用后服务端禁用 UDP 转发，只支持 TCP。

udpIdleTimeout: 60s

udpIdleTimeout 用于指定服务器对于每个 UDP 会话，在没有流量时保持本地 UDP 端口的时间长度。概念上与 NAT 的 UDP 会话超时时间相似。

验证

auth:
  type: password | userpass | http | command # (6)!
  password: your_password # (1)!
  userpass: # (2)!
    user1: pass1
    user2: pass2
    user3: pass3
  http:
    url: http://your.backend.com/auth # (3)!
    insecure: false # (4)!
  command: /etc/some_command # (5)!

用自己选的强密码进行替换。
用户名-密码映射表。
处理验证的后端 URL。
禁用后端服务器的 TLS 验证（仅适用于 HTTPS）。
处理验证的命令路径。
验证类型。请阅读页面最上方关于 "类型选择" 配置格式的说明。

HTTP 验证

当使用 HTTP 验证，客户端尝试连接时，服务器会向后端服务器发送一个带有以下 JSON 的 POST 请求：

{
  "addr": "123.123.123.123:44556", // (1)!
  "auth": "something_something", // (2)!
  "tx": 123456 // (3)!
}

客户端的地址和端口。
客户端提交的密码。
发送速率，单位为字节每秒。发送指的是服务器的视角，对应的是客户端的下载速率。

后端服务器必须返回以下 JSON：

{
  "ok": true, // (1)!
  "id": "john_doe" // (2)!
}

是否允许客户端连接。
客户 ID。用于日志和流量统计 API。

注意： HTTP 状态码必须为 200，才认为验证成功。其他状态码会被认为是验证失败。

命令验证

当使用命令验证，客户端尝试连接时，服务器将执行指定的命令并附带以下参数：

/etc/some_command addr auth tx # (1)!

每个参数的定义与上文中的 HTTP 验证部分相同。

该命令必须将客户 ID 输出到 stdout，如果允许客户端连接，则返回退出代码 0；如果客户端被拒绝，则返回非零。

如果命令执行失败，客户端将被拒绝。

DNS 解析

可以指定用于解析客户端请求中的域名的 DNS 服务器。

resolver:
  type: udp | tcp | tls | https # (8)!
  tcp:
    addr: 8.8.8.8:53 # (1)!
    timeout: 4s # (2)!
  udp:
    addr: 8.8.4.4:53 # (3)!
    timeout: 4s
  tls:
    addr: 1.1.1.1:853 # (4)!
    timeout: 10s
    sni: cloudflare-dns.com # (5)!
    insecure: false # (6)!
  https:
    addr: 1.1.1.1:443 # (7)!
    timeout: 10s
    sni: cloudflare-dns.com
    insecure: false

TCP DNS 服务器地址。
DNS 查询超时时间。
UDP DNS 服务器地址。
DNS over TLS 服务器地址。
DNS over TLS 服务器的 SNI。
禁用 TLS 证书验证。
DNS over HTTPS 服务器地址。
解析协议类型。请阅读页面最上方关于 "类型选择" 配置格式的说明。

如果省略，Hysteria 将使用系统默认的 DNS 服务器。

协议嗅探 (Sniff)

由于客户端连接入站的方式（如 TUN 模式）及配置等因素，Hysteria 有时无法获取到域名形式的目标地址，只能拿到解析后的 IP。但对于相同域名，客户端和服务端解析出的 IP 可能不同，且 ACL 的域名规则无法匹配 IP 请求。开启协议嗅探后，服务端能通过 DPI 从上层协议中获取目标域名，将 IP 请求转换为域名请求。

目前支持的协议有：

HTTP - Host 字段
TLS (HTTPS) - SNI
QUIC (HTTP/3) - SNI

sniff:
  enable: true # (1)!
  timeout: 2s # (2)!
  rewriteDomain: false # (3)!
  tcpPorts: 80,443,8000-9000 # (4)!
  udpPorts: all # (5)!

是否启用协议嗅探。
嗅探超时时间。如果超过这个时间仍然无法确定协议/获取域名，将使用原地址发起连接。
是否重写已经是域名的请求。如果启用，对于目标地址已经是域名的请求，仍会进行嗅探。
TCP 端口列表。只有这些端口的 TCP 请求会被嗅探。
UDP 端口列表。只有这些端口的 UDP 请求会被嗅探。

注意： 如果不提供端口列表，默认所有端口都会被嗅探。端口列表中的端口格式与端口跳跃相同，支持逗号分隔的多个单端口和端口范围（闭区间）。

ACL

ACL 是 Hysteria 服务端中一个非常强大的功能，可以用来自定义处理客户端请求的方式，往往配合出站规则（outbounds）使用。例如，可以使用 ACL 来屏蔽某些地址，或者针对不同网站使用不同的出口。

关于语法、使用方法以及其他信息，请参考 ACL 文档。

可以选择使用 file 或者 inline，但不能同时使用两者。

文件内联

acl:
  file: some.txt # (1)!
  # geoip: geoip.dat (2)
  # geosite: geosite.dat (3)
  # geoUpdateInterval: 168h (4)

ACL 文件的路径。
可选。取消注释以启用。GeoIP 数据库文件的路径。如果省略这个字段，Hysteria 会自动下载最新的数据库到工作目录。
可选。取消注释以启用。GeoSite 数据库文件的路径。如果省略这个字段，Hysteria 会自动下载最新的数据库到工作目录。
可选。GeoIP/GeoSite 数据库刷新的间隔。默认为 168 小时（1 周）。仅在 GeoIP/GeoSite 数据库是自动下载的情况下生效。（另请参阅下方注意事项）

acl:
  inline: # (1)!
    - reject(suffix:v2ex.com)
    - reject(all, udp/443)
    - reject(geoip:cn)
    - reject(geosite:netflix)
  # geoip: geoip.dat (2)
  # geosite: geosite.dat (3)
  # geoUpdateInterval: 168h (4)

内联 ACL 规则的列表。
可选。取消注释以启用。GeoIP 数据库文件的路径。如果省略这个字段，Hysteria 会自动下载最新的数据库到工作目录。
可选。取消注释以启用。GeoSite 数据库文件的路径。如果省略这个字段，Hysteria 会自动下载最新的数据库到工作目录。
可选。GeoIP/GeoSite 数据库刷新的间隔。默认为 168 小时（1 周）。仅在 GeoIP/GeoSite 数据库是自动下载的情况下生效。（另请参阅下方注意事项）

注意： Hysteria 目前使用的是源自 v2ray 的，基于 protobuf 的 GeoIP/GeoSite 数据库格式。如果没有自定义的需求，可以省略这两个字段，Hysteria 会自动 (从 https://github.com/Loyalsoldier/v2ray-rules-dat) 下载最新的数据库到工作目录。只有在 ACL 中有至少一条 GeoIP/GeoSite 规则时才会下载对应的数据库。

注意： 当前版本的 Hysteria 仅在启动时下载和载入 GeoIP/GeoSite 数据库，你需要借助外部工具定期重启 Hysteria 服务端，才能通过 geoUpdateInterval 定期更新 GeoIP/GeoSite 数据库。我们计划在以后的版本中完善这个功能。

出站规则 (Outbounds)

出站规则用于定义连接应通过哪个“出口”。例如，与 ACL 结合使用时，可以实现除 Netflix 外的所有流量都直接使用服务器本地网络，而 Netflix 流量通过另一个 SOCKS5 代理连接。

目前，Hysteria 支持以下几种出站类型：

direct：通过本地网络直接连接。
socks5：SOCKS5 代理。
http：HTTP/HTTPS 代理。

注意： HTTP/HTTPS 代理在协议层面不支持 UDP。将 UDP 流量发送到 HTTP 出站将导致连接被拒绝。

如果不使用 ACL，所有连接将始终通过列表中的第一个（“默认”）出站规则进行路由，所有其他出站规则将被忽略。

outbounds:
  - name: my_outbound_1 # (1)!
    type: direct # (7)!
  - name: my_outbound_2
    type: socks5
    socks5:
      addr: shady.proxy.ru:1080 # (2)!
      username: hackerman # (3)!
      password: Elliot Alderson # (4)!
  - name: my_outbound_3
    type: http
    http:
      url: http://username:[email protected]:8081 # (5)!
      insecure: false # (6)!

出站规则的名称。在 ACL 中使用。
SOCKS5 代理地址。
可选。SOCKS5 代理用户名。
可选。SOCKS5 代理密码。
HTTP/HTTPS 代理 URL。(可以是 http:// 或 https:// 开头)
可选。禁用 TLS 证书验证。仅适用于 HTTPS 代理。
请阅读页面最上方关于 "类型选择" 配置格式的说明。

关于 `direct` 出站

direct 出站规则有一些额外的选项，可以用来定制其行为：

注意： bindIPv4、bindIPv6 和 bindDevice 三者是互斥的。可以只指定 bindIPv4 和/或 bindIPv6，或者只使用 bindDevice。

outbounds:
  - name: hoho
    type: direct
    direct:
      mode: auto # (1)!
      bindIPv4: 2.4.6.8 # (2)!
      bindIPv6: 0:0:0:0:0:ffff:0204:0608 # (3)!
      bindDevice: eth233 # (4)!

详细解释见下文。
要绑定的本地 IPv4 地址。
要绑定的本地 IPv6 地址。
要绑定的本地网卡。

支持的 mode 值包括：

auto：默认值。双栈模式。客户端会同时尝试使用 IPv4 和 IPv6 地址连接目标，选择第一个成功的。
64：优先使用 IPv6，如果没有可用的 IPv6 地址，使用 IPv4。
46：优先使用 IPv4，如果没有可用的 IPv4 地址，使用 IPv6。
6：始终使用 IPv6。如果没有可用的 IPv6 地址，连接失败。
4：始终使用 IPv4。如果没有可用的 IPv4 地址，连接失败。

流量统计 API (HTTP)

流量统计 API 允许你通过 HTTP API 查询服务器的流量统计信息，以及踢用户下线。具体使用方法请参考流量统计 API 文档。

trafficStats:
  listen: :9999 # (1)!
  secret: some_secret # (2)!

监听地址。
用于验证的密钥。设置后需要在 HTTP 请求的 Authorization 头中提供正确的密钥才能访问 API。

注意： 如果不设置密钥，任何能访问 API 监听地址的人都可以查询用户流量信息和踢用户下线。强烈建议设置密钥，或至少用 ACL 阻拦对 API 监听地址的访问。

伪装 (Masquerade)

Hysteria 抵抗审查的关键之一就是它能伪装成标准的 HTTP/3 流量。这意味着数据包不仅对中间设备（middleboxes）看起来像是 HTTP/3，服务器还会像普通网站服务器一样真的响应 HTTP 请求。然而，这意味着你的服务器必须实际提供一些内容，以便看起来是真实的。

如果审查不是你需要担心的问题，可以从配置文件中完全删除 masquerade 部分。这种情况下，Hysteria 将对所有 HTTP 请求始终返回 404 Not Found 。

目前 Hysteria 提供以下几种伪装模式：

file：作为一个静态文件服务器，从一个目录提供内容。
proxy：作为一个反向代理，从另一个网站提供内容。
string：返回一个固定的字符串。

masquerade:
  type: file | proxy | string # (7)!
  file:
    dir: /www/masq # (1)!
  proxy:
    url: https://some.site.net # (2)!
    rewriteHost: true # (3)!
  string:
    content: hello stupid world # (4)!
    headers: # (5)!
      content-type: text/plain
      custom-stuff: ice cream so good
    statusCode: 200 # (6)!

用于提供文件的目录。
要代理的网站的 URL。
是否重写 Host 头以匹配被代理的网站。如果目标网站通过 Host 识别请求的网站，这个选项是必须的。
要返回的字符串。
可选。要返回的 HTTP 头列表。
可选。要返回的 HTTP 状态码。默认为 200。
伪装类型。请阅读页面最上方关于 "类型选择" 配置格式的说明。

可以通过特定参数启动 Chrome 以强制使用 QUIC，测试你的伪装配置：

chrome --origin-to-force-quic-on=your.site.com:443 # (1)!

用你服务器的域名替换。

注意： 在用参数启动 Chrome 之前，请先确保完全退出了 Chrome，没有任何 Chrome 进程还在后台运行。否则参数可能不会生效。

然后访问 https://your.site.com 验证伪装是否生效。

HTTP/HTTPS 伪装

通常支持 HTTP/3 的网站只是将其作为一个升级选项，在 80/443 端口上也提供 TCP 的 HTTP/HTTPS。如果希望模仿这种模式，可以使用 listenHTTP 和 listenHTTPS 选项来启用 HTTP/HTTPS 伪装。这种情况下，不需要用上述特殊参数启动 Chrome，和普通的网站一样访问即可验证伪装。

masquerade:
  # ... (上述其他字段)
  listenHTTP: :80 # (1)!
  listenHTTPS: :443 # (2)!
  forceHTTPS: true # (3)!

HTTP (TCP) 监听地址。
HTTPS (TCP) 监听地址。
是否强制使用 HTTPS。如果启用，HTTP 请求将被重定向到 HTTPS。

注意： 目前没有迹象表明有任何政府/商业防火墙在利用 "缺少 TCP HTTP/HTTPS" 这点来检测 Hysteria 服务器。本功能仅为执着于 "做戏做全套" 的用户提供。既然要 "做戏做全套"，就没有理由将 HTTP/HTTPS 监听在 80/443 之外的自定义端口上（虽然 Hysteria 允许自定义监听地址）。