n0-computer / iroh

peer-2-peer that just works
https://iroh.computer
Apache License 2.0
2.61k stars 165 forks source link

Documentation Missing: No example of setting listening port in configuration documentation #2501

Open haltingstate opened 4 months ago

haltingstate commented 4 months ago

There is no example configuration file.

It is currently impossible to change or set the listening ports.

Therefore it is important for configuration files to be used as they are undocumented and have no example and there is absolutely no way for users to set listening ip/ports for iroh.


See:

dignifiedquire commented 4 months ago

The main documentation for the library lives on docs.rs currently. Binding to a non default port is documented here: https://docs.rs/iroh/latest/iroh/node/struct.Builder.html#method.bind_port

haltingstate commented 4 months ago

The main documentation for the library lives on docs.rs currently. Binding to a non default port is documented here: https://docs.rs/iroh/latest/iroh/node/struct.Builder.html#method.bind_port

Can we update the documentation here

To include an example of a configuration file where the ports are configured?

I think modifying the source code in rust, might be too difficult for people deploying from the binary.