-
Notifications
You must be signed in to change notification settings - Fork 38.7k
Make rpcauth help message clearer, add example in example .conf #9401
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
Conversation
| #rpcbind=<addr> | ||
|
|
||
| # You must set rpcuser and rpcpassword to secure the JSON-RPC api | ||
| # If no rpcpassword is set, rpc cookie auth is sought. The default `-rpccookiefile` name |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note: cookie is only created if -server=1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you imagine any reason why it would be otherwise?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, but more than one user was apparently confused by this!(getting feedback offline) Maybe it's too obvious.
| strUsage += HelpMessageOpt("-rpcuser=<user>", _("Username for JSON-RPC connections")); | ||
| strUsage += HelpMessageOpt("-rpcpassword=<pw>", _("Password for JSON-RPC connections")); | ||
| strUsage += HelpMessageOpt("-rpcauth=<userpw>", _("Username and hashed password for JSON-RPC connections. The field <userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A canonical python script is included in share/rpcuser. This option can be specified multiple times")); | ||
| strUsage += HelpMessageOpt("-rpcauth=<userpw>", _("Username and hashed password for JSON-RPC connections. The field <userpw> comes in the format: <USERNAME>:<SALT>$<HASH>. A canonical python script is included in share/rpcuser. The client then connects normally using the rpcuser=<USERNAME>/rpcpassword=<PASSWORD> pair of arguments. This option can be specified multiple times")); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could make sense to split the translation string into smaller logical chunks while touching?
|
ACK 0513c70 |
…e .conf 0513c70 Make rpcauth help message clearer, add example in example .conf (Gregory Sanders)
… example .conf 0513c70 Make rpcauth help message clearer, add example in example .conf (Gregory Sanders)
… example .conf 0513c70 Make rpcauth help message clearer, add example in example .conf (Gregory Sanders)
… example .conf 0513c70 Make rpcauth help message clearer, add example in example .conf (Gregory Sanders)
Some users are confused about the interplay of the three different ways of authenticating rpc requests. This is meant to give extra clarity.