Skip to content

Docs: Control Port not always enabled by default#13681

Closed
JBaczuk wants to merge 2 commits intobitcoin:masterfrom
JBaczuk:torrc_config_doc_notes
Closed

Docs: Control Port not always enabled by default#13681
JBaczuk wants to merge 2 commits intobitcoin:masterfrom
JBaczuk:torrc_config_doc_notes

Conversation

@JBaczuk
Copy link
Contributor

@JBaczuk JBaczuk commented Jul 17, 2018

added note that for tor to work in automatic mode, the control port must be enabled and also added how to do that by using torrc config file.

@fanquake fanquake added the Docs label Jul 17, 2018
@fanquake
Copy link
Member

Please remove the trailing whitespace from the lines you've added. That is what's causing the tests to fail.

doc/tor.md Outdated
configured. For cookie authentication the user running bitcoind must have write access
to the `CookieAuthFile` specified in Tor configuration. In some cases this is
configured. It also requires the control socket to be enabled, eg. put `ControlPort 9051`
in torrc config file. For cookie authentication the user running bitcoind must have write
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Use `torrc`

doc/tor.md Outdated
Connecting to Tor's control socket API requires one of two authentication methods to be
configured. For cookie authentication the user running bitcoind must have write access
to the `CookieAuthFile` specified in Tor configuration. In some cases this is
configured. It also requires the control socket to be enabled, eg. put `ControlPort 9051`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: "e.g."

@DrahtBot
Copy link
Contributor

Note to reviewers: This pull request conflicts with the following ones:

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

Connecting to Tor's control socket API requires one of two authentication methods to be
configured. It also requires the control socket to be enabled, e.g. put `ControlPort 9051`
in `torrc` config file. For cookie authentication the user running bitcoind must have write
access to the `CookieAuthFile` specified in Tor configuration. In some cases this is
Copy link
Member

@laanwj laanwj Jul 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not your doing, but I think this statement is not correct. It needs read access to the cookie file (to be able to send it for authentication), not write access.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like the author copied that wording from the tor spec. The user running the tor daemon needs the write access, and the user running bitcoind should only need read.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

exactly

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok I've made this change, apologies, I didn't realize this was holding this PR up.

@DrahtBot
Copy link
Contributor

DrahtBot commented Aug 2, 2018

Needs rebase

@laanwj
Copy link
Member

laanwj commented Aug 31, 2018

Closing this, let me know if you want to pick it up again, but this is taking much too long for a documentation-only change

@laanwj laanwj closed this Aug 31, 2018
@JBaczuk
Copy link
Contributor Author

JBaczuk commented Aug 31, 2018

Apologies, what exactly is holding this up?

@maflcko
Copy link
Member

maflcko commented Aug 31, 2018

@JBaczuk Could you please address the in-line feedback?

@JBaczuk
Copy link
Contributor Author

JBaczuk commented Aug 31, 2018

@MarcoFalke oh, ok done.

@maflcko
Copy link
Member

maflcko commented Aug 31, 2018

This pull is still closed and it won't let me reopen due to the push.

@JBaczuk
Copy link
Contributor Author

JBaczuk commented Aug 31, 2018

I didn't know that could happen, what's the proper procedure here?

@maflcko
Copy link
Member

maflcko commented Aug 31, 2018

There hasn't been any substantial discussion, so feel free to open a new pull request in this case.

@JBaczuk
Copy link
Contributor Author

JBaczuk commented Aug 31, 2018

Ok reopened as #14120

laanwj added a commit that referenced this pull request Sep 2, 2018
fb97437 added note that control port must be enabled and how to do that in torrc config file (Jordan Baczuk)

Pull request description:

  Reopened from #13681 because pushes made it unable to reopen.

Tree-SHA512: 34eac14308aef70963b630173cd93916201553d5323ab2de3517d4a78604ae5a7cf8691a314c0af00fe36f0ef19b94a4c371d2e7aa1229d9c603d36c51b115fb
UdjinM6 pushed a commit to UdjinM6/dash that referenced this pull request Jul 3, 2021
fb97437 added note that control port must be enabled and how to do that in torrc config file (Jordan Baczuk)

Pull request description:

  Reopened from bitcoin#13681 because pushes made it unable to reopen.

Tree-SHA512: 34eac14308aef70963b630173cd93916201553d5323ab2de3517d4a78604ae5a7cf8691a314c0af00fe36f0ef19b94a4c371d2e7aa1229d9c603d36c51b115fb
Munkybooty pushed a commit to Munkybooty/dash that referenced this pull request Jul 8, 2021
fb97437 added note that control port must be enabled and how to do that in torrc config file (Jordan Baczuk)

Pull request description:

  Reopened from bitcoin#13681 because pushes made it unable to reopen.

Tree-SHA512: 34eac14308aef70963b630173cd93916201553d5323ab2de3517d4a78604ae5a7cf8691a314c0af00fe36f0ef19b94a4c371d2e7aa1229d9c603d36c51b115fb
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Dec 16, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants