Rename 'out_routes' to 'out_links' in configuration files

mel-project · nullchinchilla · Jul 10, 2025 · Jul 10, 2025 · Jul 10, 2025 · Jul 10, 2025
commit 472f7c8560be70a9462a6bf25a30d79ab1a65d91
diff --git a/en/getting-started/config.md b/en/getting-started/config.md
@@ -17,8 +17,8 @@ db_path: ./.cache/earendil
 control_listen: 127.0.0.1:11111
 
 # ------------------------ routing config ----------------------------
-# relays to connect to as neighbors. Client configs *must* contain at least one `out_route`; optional for relays.
-out_routes:
+# relays to connect to as neighbors. Client configs *must* contain at least one `out_link`; optional for relays.
+out_links:
   example-relay:
     # IP address and port where the relay is listening for incoming connections
     connect: 62.210.93.59:12345

diff --git a/en/getting-started/havens.md b/en/getting-started/havens.md
@@ -9,7 +9,7 @@ This tutorial will teach you how to use and host basic Earendil havens.
 You can access HTTP-based havens right in your browser. Paste the following config file into the "Settings" tab of your Earendil GUI:
 
 ```yaml
-out_routes:
+out_links:
   example-relay-free:
     connect: 62.210.93.59:12345
     fingerprint: 4b7a641b77c2d6ceb8b3fecec2b2978dfe81ae045ed9a25ed78b828009c4967a
@@ -68,7 +68,7 @@ server {
 Paste this config file into your Earendil GUI's "Settings" tab:
 
 ```yaml
-out_routes:
+out_links:
   example-relay-free:
     connect: 62.210.93.59:12345
     fingerprint: 4b7a641b77c2d6ceb8b3fecec2b2978dfe81ae045ed9a25ed78b828009c4967a

diff --git a/en/getting-started/host-proxy.md b/en/getting-started/host-proxy.md
@@ -7,7 +7,7 @@ Both client and relay Earendil nodes can host web proxies. When you host an Eare
 To host a web proxy, paste this config file into the "Settings" tab of your Earendil GUI:
 
 ```yaml
-out_routes:
+out_links:
   example-relay-free:
     connect: 62.210.93.59:12345
     fingerprint: 4b7a641b77c2d6ceb8b3fecec2b2978dfe81ae045ed9a25ed78b828009c4967a

diff --git a/en/getting-started/pay.md b/en/getting-started/pay.md
@@ -12,10 +12,10 @@ To learn more about Earendil's incentive system, read [this post](https://nullch
 
 ## Price & debt limit
 
-Two neighbors agree **out-of-band** on a price and debt limit for sending packets when they first connect to each other. They then specify this information in the `price_config` section of the `in_link` or `out_route` block:
+Two neighbors agree **out-of-band** on a price and debt limit for sending packets when they first connect to each other. They then specify this information in the `price_config` section of the `in_link` or `out_link` block:
 
 ```yaml
-# every in_link and out_route has a price_config
+# every in_link and out_link has a price_config
 price_config:
   # how much you charge per incoming packet, in µMEL
   inbound_price: 5
@@ -40,7 +40,7 @@ price_config:
   outbound_min_debt_limit: 0
 ```
 
-While Bob has this `price_config` in his out_route for connecting to Alice:
+While Bob has this `price_config` in his out_link for connecting to Alice:
 
 ```yaml
 price_config:

diff --git a/en/getting-started/quick-start.md b/en/getting-started/quick-start.md
@@ -16,7 +16,7 @@ Paste this config file into your Settings tab:
 
 ```yaml
 # relays to connect to
-out_routes:
+out_links:
   # arbitrary name for this relay
   example-relay-free:
     # IP and port where the relay is listening

diff --git a/en/getting-started/run-relay.md b/en/getting-started/run-relay.md
@@ -8,7 +8,7 @@ To run a relay, save this config file into a file named `relay-cfg.yaml`. Be sur
 
 ```yaml
 # neighbors, same as in client config
-out_routes:
+out_links:
   example-relay-free:
     connect: 62.210.93.59:12345
     fingerprint: 4b7a641b77c2d6ceb8b3fecec2b2978dfe81ae045ed9a25ed78b828009c4967a
@@ -58,7 +58,7 @@ main_udp:
     outbound_min_debt_limit: 0
 ```
 
-Replace `<YOUR_IP>` with your server's public IP address. Other nodes (both clients and relays) can simply paste this block into the `out_routes` section of their config file to add your relay as a neighbor.
+Replace `<YOUR_IP>` with your server's public IP address. Other nodes (both clients and relays) can simply paste this block into the `out_links` section of their config file to add your relay as a neighbor.
 
 {% hint style="warning" %}
 To serve users in regions with internet censorship, you should _avoid_ posting your relay's contact information publicly. Instead, distribute it in a way that reaches legitimate users but not censors--your relay will be blacklisted if the censor learns its IP address!

diff --git a/en/wiki/protocols/debt-accounting.md b/en/wiki/protocols/debt-accounting.md
@@ -20,7 +20,7 @@ Each sides refuses to peel/relay any packets until the other side has signaled a
 
 `push_price` may be called at any point, with the understanding that the other side may take a while to apply the changes to how debt etc is calculated.
 
-`in_link` and `out_route` in config files specify maximum allowable prices and debt limit ranges.
+`in_link` and `out_link` in config files specify maximum allowable prices and debt limit ranges.
 
 ## Tracking debt
 

diff --git a/en/wiki/relay-configuration.md b/en/wiki/relay-configuration.md
@@ -4,7 +4,7 @@ Every connection between relays is bidirectional and symmetric once established.
 
 But how these connections are configured is not symmetric. There is a distinction between accepting a connection from a peer passively, and contacting a peer actively.
 
-This is reflected in the configuration file, where the `in_links` mapping specifies _ways to accept_ incoming connections, while the `out_routes` mapping specifies _specific outgoing connections_.
+This is reflected in the configuration file, where the `in_links` mapping specifies _ways to accept_ incoming connections, while the `out_links` mapping specifies _specific outgoing connections_.
 
 {% code title="/etc/earendil/config.yaml" %}
 ```yaml
@@ -26,7 +26,7 @@ in_links:
             certificate: autoconf
 
 # list of all outgoing connections
-out_routes:
+out_links:
     alice:
         fingerprint: KCKUhWZfluAzMzwiw721CNrvyhc
         protocol: obfsudp

diff --git a/zh-cn/ru-men-zhi-nan/bi-feng-gang-havens.md b/zh-cn/ru-men-zhi-nan/bi-feng-gang-havens.md
@@ -10,7 +10,7 @@
 
 ```yaml
 state_cache: /your/path/.cache/earendil # 用于存储持久信息的位置。必须是绝对路径
-out_routes: # 要连接的中继
+out_links: # 要连接的中继
   example-relay: # 此中继的任意名称
     connect: 62.210.93.59:12345 # 中继监听的 IP 和端口
     fingerprint: 4b7a641b77c2d6ceb8b3fecec2b2978dfe81ae045ed9a25ed78b828009c4967a # 中继的长期身份
@@ -71,7 +71,7 @@ server {
 ```yaml
 state_cache: /your/path/.cache/earendil # 用于存储持久信息的位置。必须是绝对路径
 
-out_routes: # 要连接的中继
+out_links: # 要连接的中继
   example-relay: # 此中继的任意名称
     connect: 62.210.93.59:12345 # 中继监听的 IP 和端口
     fingerprint: 4b7a641b77c2d6ceb8b3fecec2b2978dfe81ae045ed9a25ed78b828009c4967a # 中继的长期身份

diff --git a/zh-cn/ru-men-zhi-nan/kuai-su-ru-men.md b/zh-cn/ru-men-zhi-nan/kuai-su-ru-men.md
@@ -15,7 +15,7 @@
 将此配置文件粘贴到您的设置标签中。请确保将 "/your/path/" 替换为适当的路径：
 
 ```yaml
-out_routes: # 要连接的中继
+out_links: # 要连接的中继
   example-relay: # 此中继的任意名称
     connect: 62.210.93.59:12345 # 中继监听的 IP 和端口
     fingerprint: 4b7a641b77c2d6ceb8b3fecec2b2978dfe81ae045ed9a25ed78b828009c4967a # 中继的长期身份

diff --git a/zh-cn/ru-men-zhi-nan/pei-zhi-wen-jian.md b/zh-cn/ru-men-zhi-nan/pei-zhi-wen-jian.md
@@ -17,8 +17,8 @@ db_path: ./.cache/earendil
 control_listen: 127.0.0.1:11111
 
 # ------------------------ 路由配置 ----------------------------
-# 作为邻居连接的中继。客户端配置*必须*至少包含一个 `out_route`；对于中继是可选的。
-out_routes:
+# 作为邻居连接的中继。客户端配置*必须*至少包含一个 `out_link`；对于中继是可选的。
+out_links:
   example-relay:
     # 中继监听传入连接的 IP 地址和端口
     connect: 62.210.93.59:12345

diff --git a/zh-cn/ru-men-zhi-nan/yun-xing-wang-ye-dai-li.md b/zh-cn/ru-men-zhi-nan/yun-xing-wang-ye-dai-li.md
@@ -7,7 +7,7 @@ Earendil 客户端和中继节点均可运营网页代理。当您托管一个 E
 要托管网页代理，请将此配置文件粘贴到您的 Earendil 图形界面的 "Settings" 标签中：
 
 ```yaml
-out_routes:
+out_links:
   example-relay-free:
     connect: 62.210.93.59:12345
     fingerprint: 4b7a641b77c2d6ceb8b3fecec2b2978dfe81ae045ed9a25ed78b828009c4967a

diff --git a/zh-cn/ru-men-zhi-nan/yun-xing-zhong-ji.md b/zh-cn/ru-men-zhi-nan/yun-xing-zhong-ji.md
@@ -11,7 +11,7 @@
 state_cache: /your/path/.cache/earendil # 存储持久信息的位置。必须是绝对路径
 
 # 邻居，与客户端配置相同
-out_routes:
+out_links:
   example-relay:
     connect: 62.210.93.59:12345
     fingerprint: 4b7a641b77c2d6ceb8b3fecec2b2978dfe81ae045ed9a25ed78b828009c4967a
@@ -50,7 +50,7 @@ main_udp:
     sosistab3: <your_random_seed>
 ```
 
-请将 `<YOUR_IP>` 替换为您服务器的公网 IP 地址。其他节点（客户端和中继都一样）可以地将这个块粘贴到他们的配置文件的 `out_routes` 部分，以添加您的中继作为邻居。
+请将 `<YOUR_IP>` 替换为您服务器的公网 IP 地址。其他节点（客户端和中继都一样）可以地将这个块粘贴到他们的配置文件的 `out_links` 部分，以添加您的中继作为邻居。
 
 {% hint style="warning" %}
 如果您想服务于有着互联网审查地区的用户，请避免公开发布您的中继联系信息。您应使用一种避免让审查者发现中继信息的方式把信息传递给真正的用户——如果审查者了解到您中继的 IP 地址，您的中继会被列入黑名单。

diff --git a/zh-cn/ru-men-zhi-nan/zhi-fu.md b/zh-cn/ru-men-zhi-nan/zhi-fu.md
@@ -12,10 +12,10 @@
 
 ## 价格与债务限额
 
-两个邻居在首次连接时**离线**同意一个发送数据包的价格和债务限额。然后他们在 `in_link` 或 `out_route` 块的 `price_config` 部分中指定这些信息：
+两个邻居在首次连接时**离线**同意一个发送数据包的价格和债务限额。然后他们在 `in_link` 或 `out_link` 块的 `price_config` 部分中指定这些信息：
 
 ```yaml
-# 每个 in_link 和 out_route 都有一个 price_config
+# 每个 in_link 和 out_link 都有一个 price_config
 price_config:
   # 你对每个传入的数据包收取的费用，以 µMEL 为单位
   inbound_price: 5
@@ -40,7 +40,7 @@ price_config:
   outbound_min_debt_limit: 0
 ```
 
-而 Bob 在他连接到 Alice 的`out_route`中有以下 `price_config`：
+而 Bob 在他连接到 Alice 的`out_link`中有以下 `price_config`：
 
 ```yaml
 price_config: