Skip to content
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

docs: Update doc.go with latest arguments. #2924

Merged
merged 1 commit into from Apr 19, 2022

Conversation

matthawkins90
Copy link
Contributor

New arguments according to config.go:

  • --logsize
  • --authtype
  • --clientcafile

Also fixed a minor typo in --externalip to match standard formatting.

@matthawkins90
Copy link
Contributor Author

This might be out of scope of this PR, but I don't really understand what --externalip and --nodiscoverip do.

externalip = "Add an IP to the list of local addresses we claim to listen on to peers"
nodiscoverip = "Disable automatic network address discovery of local external IPs"

How is externalip different from addpeer?

How is nodiscoverip different from nolisten or noseeders?

@davecgh
Copy link
Member

davecgh commented Apr 12, 2022

Essentially, inbound vs outbound. externalip/nodiscoverip has to do with the IP that you advertise to other peers in order for them to be able to connect inbound to your node, because often nodes are sitting behind NAT, VPNs, etc and therefore the external IP (aka your public IP that is visible to the internet) is not the same as whatever your local IP is (which is often something like 192.168.x.x).

addpeer is for specifying other peers to always maintain an outbound connection to and is most useful for miners and more exotic network setups such as when you have multiple nodes sitting behind a VPN that you want to remain private but still ensure are connected with your exit node so they can stay synced to the network.

nolisten turns off the ability to accept inbound connections via p2p altogether.

noseeders turns off the ability to discover other peers via the https-based seeders. Without those, it only uses whatever addresses have previously been discovered and are stored in the local address manager.

@matthawkins90
Copy link
Contributor Author

matthawkins90 commented Apr 12, 2022

Ok, so when the description for externalip says the list we claim to listen to, who is "we"? Is it the Decred Seeders?

Can we change that description to something more clear, something like:
externalip = "Add an IP to the list of local addresses that dcrd will advertise to other peers (default: your external WAN IP)"

nodiscoverip = "Disable automatic network address discovery of local external IPs which will be broadcast to other peers"

I'm not even sure my suggestions are more clear, but I think both descriptions could use some improvement.

@davecgh
Copy link
Member

davecgh commented Apr 12, 2022

"we" is us, as in the local node. I don't mind the updated descriptions, except the default probably shouldn't be there because the real value is not available at the point the help is run.

@davecgh davecgh added this to the 1.8.0 milestone Apr 13, 2022
@davecgh davecgh added the documentation Issues and/or pull requests related to documentation. label Apr 13, 2022
@davecgh davecgh merged commit 7d665db into decred:master Apr 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues and/or pull requests related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants