Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
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
Prev Previous commit
Next Next commit
Rename in_routes to in_links in config files for consistency
  • Loading branch information
nullchinchilla committed Jul 10, 2025
commit 1fa2978102db1a41f9d951d564f488d2e508d12b
6 changes: 3 additions & 3 deletions en/getting-started/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,20 +95,20 @@ relay_config:
identity_file: /your/path/identity.secret

# where & how to accept incoming connections
in_routes:
in_links:
main_obfs:
# obfuscation protocol to use, for resisting ISP-level censorship
obfs:
sosistab3: snake-before-antenna-toward-floor-stuff-frozen-power-avocado-retire-grunt-nation
# TCP port this in_route listens at
# TCP port this in_link listens at
listen: 0.0.0.0:19999
# price config for this route, in µMELs
price_config:
inbound_price: 5
inbound_debt_limit: 50000
outbound_max_price: 0
outbound_min_debt_limit: 0
# another in_route, with no obfuscation
# another in_link, with no obfuscation
no_obfs:
obfs: none
listen: 0.0.0.0:19998
Expand Down
6 changes: 3 additions & 3 deletions en/getting-started/pay.md
Original file line number Diff line number Diff line change
Expand Up @@ -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_route` 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_route` block:

```yaml
# every in_route and out_route has a price_config
# every in_link and out_route has a price_config
price_config:
# how much you charge per incoming packet, in µMEL
inbound_price: 5
Expand All @@ -30,7 +30,7 @@ price_config:
outbound_min_debt_limit: -100
```

As an example, say we have relay Alice and client Bob. Alice has this `price_config` in her in_route for Bob:
As an example, say we have relay Alice and client Bob. Alice has this `price_config` in her in_link for Bob:

```yaml
price_config:
Expand Down
4 changes: 2 additions & 2 deletions en/getting-started/run-relay.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

We currently only support running relays using the CLI version. **Relays should be run on machines with public IP addresses**.

Relays and clients nodes use the same `earendil` executable. The defining difference is in their config file: relay configs have a `relay_config` section that specifies `identity_file` (to store the relay's long-term identity) and `in_routes` (where and how to accept incoming connections), while client configs do not.
Relays and clients nodes use the same `earendil` executable. The defining difference is in their config file: relay configs have a `relay_config` section that specifies `identity_file` (to store the relay's long-term identity) and `in_links` (where and how to accept incoming connections), while client configs do not.

To run a relay, save this config file into a file named `relay-cfg.yaml`. Be sure to replace "/your/path/\` with an appropriate path:

Expand All @@ -20,7 +20,7 @@ relay_config:
# replace with a writable path for storing identity secret
identity_file: /your/path/earendil-relay-id.secret

in_routes:
in_links:
main_udp:
obfs:
# random seed for obfsudp cookie. Generate your own with `earendil generate-seed`
Expand Down
2 changes: 1 addition & 1 deletion en/wiki/protocols/debt-accounting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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_route` and `out_route` in config files specify maximum allowable prices and debt limit ranges.
`in_link` and `out_route` in config files specify maximum allowable prices and debt limit ranges.

## Tracking debt

Expand Down
4 changes: 2 additions & 2 deletions en/wiki/relay-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ 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_routes` 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_routes` mapping specifies _specific outgoing connections_.

{% code title="/etc/earendil/config.yaml" %}
```yaml
identity: /etc/earendil/identity.asc
state_cache: /etc/earendil/state_cache.db

# listeners for incoming connections
in_routes:
in_links:
main_udp:
protocol: obfsudp
listen: 0.0.0.0:19999
Expand Down
6 changes: 3 additions & 3 deletions zh-cn/ru-men-zhi-nan/pei-zhi-wen-jian.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,20 +106,20 @@ relay_config:
identity_file: /your/path/identity.secret

# 接受传入连接的位置和方式
in_routes:
in_links:
main_obfs:
# 使用的混淆协议,用于抵抗 ISP 级别的审查
obfs:
sosistab3: snake-before-antenna-toward-floor-stuff-frozen-power-avocado-retire-grunt-nation
# 此 in_route 监听的 TCP 端口
# 此 in_link 监听的 TCP 端口
listen: 0.0.0.0:19999
# 此路由的价格配置,以 µMEL 为单位
price_config:
inbound_price: 5
inbound_debt_limit: 50000
outbound_max_price: 0
outbound_min_debt_limit: 0
# 另一个 in_route,无混淆
# 另一个 in_link,无混淆
no_obfs:
obfs: none
listen: 0.0.0.0:19998
Expand Down
2 changes: 1 addition & 1 deletion zh-cn/ru-men-zhi-nan/yun-xing-zhong-ji.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ out_routes:
# 中继设置
identity_file: /your/path/identity.secret # 替换为一个可写入的路径用于存储身份秘钥

in_routes:
in_links:
main_udp:
obfs:
sosistab3: <your_random_seed> # obfsudp cookie 的随机种子。使用 `earendil generate-seed` 生成您自己的种子
Expand Down
6 changes: 3 additions & 3 deletions zh-cn/ru-men-zhi-nan/zhi-fu.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@

## 价格与债务限额

两个邻居在首次连接时**离线**同意一个发送数据包的价格和债务限额。然后他们在 `in_route` 或 `out_route` 块的 `price_config` 部分中指定这些信息:
两个邻居在首次连接时**离线**同意一个发送数据包的价格和债务限额。然后他们在 `in_link` 或 `out_route` 块的 `price_config` 部分中指定这些信息:

```yaml
# 每个 in_route 和 out_route 都有一个 price_config
# 每个 in_link 和 out_route 都有一个 price_config
price_config:
# 你对每个传入的数据包收取的费用,以 µMEL 为单位
inbound_price: 5
Expand All @@ -30,7 +30,7 @@ price_config:
outbound_min_debt_limit: -100
```

例如,假设我们有中继 Alice 和客户端 Bob。Alice 在她的连接到 Bob 的`in_route`中有以下 `price_config`:
例如,假设我们有中继 Alice 和客户端 Bob。Alice 在她的连接到 Bob 的`in_link`中有以下 `price_config`:

```yaml
price_config:
Expand Down