doc: warn that incoming conns are unlikely when not using default ports #20668

1. 
   adamjonas commented at 2:33 am on December 16, 2020: member

   Closes #5150.

   This was mostly copied from #5285 by sulks, who has since quit GitHub.

   The issue has remained open for 6 years, but the extra explanation still seems useful.

2. DrahtBot added the label Docs on Dec 16, 2020
3. DrahtBot added the label P2P on Dec 16, 2020
4. 
   laanwj commented at 10:27 am on December 16, 2020: member

   ACK b2bbc089888015e86ce3cbe145fd5a61695205ff

   diff:

    0--- /tmp/1.log  2020-12-17 12:05:19.661809857 +0100
    1+++ /tmp/2.log  2020-12-17 12:04:46.502043685 +0100
    2@@ -1,4 +1,4 @@
    3-Bitcoin Core version v21.99.0-f0913f2f950c7a3e0a14d32216bd6ce4e19d85df
    4+Bitcoin Core version v21.99.0-6d74b0e0ac6e9bc63a893ca3cfe33362d445f595
    5 Copyright (C) 2009-2020 The Bitcoin Core developers
    6 
    7 Please contribute if you find Bitcoin Core useful. Visit
    8@@ -238,8 +238,9 @@
    9        Relay non-P2SH multisig (default: 1)
   10 
   11   -port=<port>
   12-       Listen for connections on <port> (default: 8333, testnet: 18333 signet:
   13-       38333, regtest: 18444)
   14+       Listen for connections on <port>. Nodes not using the default ports
   15+       (default: 8333, testnet: 18333, signet: 38333, regtest: 18444)
   16+       are unlikely to get incoming connections.
   17 
   18   -proxy=<ip:port>
   19        Connect through SOCKS5 proxy, set -noproxy to disable (default:
   

   re-ACK 010eed3ce03cf4fc622a48f40fc4d589383f7a44

5. in src/init.cpp:453 in b2bbc08988 outdated

   449@@ -450,7 +450,7 @@ void SetupServerArgs(NodeContext& node)
   450     argsman.AddArg("-peerbloomfilters", strprintf("Support filtering of blocks and transaction with bloom filters (default: %u)", DEFAULT_PEERBLOOMFILTERS), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
   451     argsman.AddArg("-peerblockfilters", strprintf("Serve compact block filters to peers per BIP 157 (default: %u)", DEFAULT_PEERBLOCKFILTERS), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
   452     argsman.AddArg("-permitbaremultisig", strprintf("Relay non-P2SH multisig (default: %u)", DEFAULT_PERMIT_BAREMULTISIG), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
   453-    argsman.AddArg("-port=<port>", strprintf("Listen for connections on <port> (default: %u, testnet: %u signet: %u, regtest: %u)", defaultChainParams->GetDefaultPort(), testnetChainParams->GetDefaultPort(), signetChainParams->GetDefaultPort(), regtestChainParams->GetDefaultPort()), ArgsManager::ALLOW_ANY | ArgsManager::NETWORK_ONLY, OptionsCategory::CONNECTION);
   454+    argsman.AddArg("-port=<port>", strprintf("Listen for connections on <port>. Nodes not using the default ports (default: %u, testnet: %u, signet: %u, regtest: %u) will be unlikely to get incoming connections.", defaultChainParams->GetDefaultPort(), testnetChainParams->GetDefaultPort(), signetChainParams->GetDefaultPort(), regtestChainParams->GetDefaultPort()), ArgsManager::ALLOW_ANY | ArgsManager::NETWORK_ONLY, OptionsCategory::CONNECTION);
   

   ---

   ---

   

   jonatack commented at 11:45 am on December 16, 2020:

   thanks for fixing up the grammar while here

   tried to make this part more easy/clear, not sure it’s better (“not using”…“not see” symmetry)

   0    argsman.AddArg("-port=<port>", strprintf("Listen for connections on <port>. Nodes not using the default ports (default: %u, testnet: %u, signet: %u, regtest: %u) will likely not see incoming connections.", defaultChainParams->GetDefaultPort(), testnetChainParams->GetDefaultPort(), signetChainParams->GetDefaultPort(), regtestChainParams->GetDefaultPort()), ArgsManager::ALLOW_ANY | ArgsManager::NETWORK_ONLY, OptionsCategory::CONNECTION);
   

   ---

   

   practicalswift commented at 12:03 pm on December 16, 2020:

   Nit: “are” instead of “will be”?
6. 
   jonatack commented at 11:49 am on December 16, 2020: member

   utACK b2bbc089888015e86ce3cbe145fd5a61695205ff
7. 
   MarcoFalke commented at 11:59 am on December 16, 2020: member

   ACK b2bbc089888015e86ce3cbe145fd5a61695205ff

   Nice find

8. doc: warn that incoming conns are unlikely when not using default ports 010eed3ce0
9. adamjonas force-pushed on Dec 16, 2020
10. 
    adamjonas commented at 2:27 pm on December 16, 2020: member

    Updated to go with @practicalswift’s readability recommendation.

    Thanks for the quick review and suggestions.

11. laanwj merged this on Dec 17, 2020
12. laanwj closed this on Dec 17, 2020

    ---

13. MarcoFalke referenced this in commit 84e8d5467f on Dec 17, 2020
14. sidhujag referenced this in commit 24de220d34 on Dec 17, 2020
15. MarcoFalke referenced this in commit 22a9018649 on Oct 25, 2021
16. DrahtBot locked this on Feb 15, 2022

Contributors
adamjonas laanwj jonatack practicalswift MarcoFalke

Labels
Docs P2P