Skip to content

docs: iroh-relay doesn't create default config file as described in help #3258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
adiibanez opened this issue Apr 6, 2025 · 1 comment
Labels
c-iroh-relay docs Improvements or additions to documentation
Milestone

Comments

@adiibanez
Copy link

https://github.com/n0-computer/iroh/releases/download/v0.34.0/iroh-relay-v0.34.0-aarch64-apple-darwin.tar.gz

iroh-relay --help
-c, --config-path <CONFIG_PATH>
Path to the configuration file.

      If provided and no configuration file exists the default configuration will be written to the file.

tried cargo run --features=server --bin iroh-relay -- --config-path=iroh-relay-config.toml --dev too

Relevant Logs
RUST_LOG=debug ./iroh-relay --config-path test.toml
2025-04-06T17:20:31.614293Z DEBUG iroh_relay: ServerConfig {
relay: Some(
RelayConfig {
http_bind_addr: [::]:80,
tls: None,
limits: Limits {
accept_conn_limit: None,
accept_conn_burst: None,
client_rx: None,
},
key_cache_capacity: None,
access: Everyone,
},
),
stun: Some(
StunConfig {
bind_addr: [::]:3478,
},
),
quic: None,
metrics_addr: Some(
[::]:9090,
),
}
2025-04-06T17:20:31.614767Z DEBUG iroh_relay::server: Starting metrics server
2025-04-06T17:20:31.614815Z DEBUG iroh_relay::server: Starting STUN server
2025-04-06T17:20:31.614868Z INFO iroh_relay::server: STUN server listening on [::]:3478
2025-04-06T17:20:31.614841Z INFO metrics-server: iroh_metrics::service: Starting metrics server on [::]:9090
2025-04-06T17:20:31.614893Z DEBUG iroh_relay::server: Starting Relay server
2025-04-06T17:20:31.614953Z INFO stun-server{addr=[::]:3478}: iroh_relay::server: running STUN server addr=Some([::]:3478)
2025-04-06T17:20:31.615277Z INFO iroh_relay::server::http_server: [HTTP/WS] relay: serving on [::]:80
2025-04-06T17:20:31.618156Z DEBUG iroh_relay::server: STUN: received binding request src_addr=[::1]:49403

Expected behavior
generate config file containing defaults. Or sample file with defaults and helpful comments somewhere in the repo

Platform(s)
Desktop:

  • OS: OSX
  • Version 15.3.1 (24D70)
@adiibanez adiibanez added the bug Something isn't working label Apr 6, 2025
@n0bot n0bot bot added this to iroh Apr 6, 2025
@flub
Copy link
Contributor

flub commented Apr 7, 2025

Yeah, that functionality has been removed on purpose. But the help text still needs to be updated to reflect that.

I'm afraid the only way to figure out the config format of the relay server is to read the config structs in the source code. The relay server hasn't really been treated like an end-user porduct...

I'll leave this issue open to update the docs.

@flub flub added docs Improvements or additions to documentation c-iroh-relay and removed bug Something isn't working labels Apr 7, 2025
@flub flub added this to the v1.0.0 milestone Apr 7, 2025
@matheus23 matheus23 changed the title bug: iroh-relay doesn't create default config file as described in help docs: iroh-relay doesn't create default config file as described in help Apr 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c-iroh-relay docs Improvements or additions to documentation
Projects
Status: No status
Development

No branches or pull requests

2 participants