Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Document configuration parameters for running Bitcoin Core #806

Closed
jlopp opened this Issue Apr 7, 2015 · 9 comments

Comments

Projects
None yet
5 participants
Contributor

jlopp commented Apr 7, 2015

I think this would be really useful to add as a section to the "Running a Full Node" guide. Basically an in-depth guide to each configuration parameter that you can pass as a command line argument or add as a line to bitcoin.conf

Basically, a better version of this document: https://en.bitcoin.it/wiki/Running_Bitcoin

Contributor

harding commented Apr 7, 2015

@jlopp you're not the first person to request that, and I think it's increasingly needed as the config parameters seem to be both increasing in number and becoming more complex (including the complexity of interaction between params).

When I re-wrote the RPC section last year, I had the idea that we might move them into a separate document dedicated to just Bitcoin Core API-like stuff, and I think that'd be an obvious place for documentation of the config params.

However, I'd be interested in hearing what other people think about merging the moderately-technical full node docs with a highly-technical API doc. On first thought, I think I'd like to work on making the full node docs less complex and less detailed (as much as possible), so maybe we'd just link from the full node docs to the Bitcoin Core docs config params section for anyone geeky enough to use non-defaults.

Contributor

jlopp commented Apr 7, 2015

It makes sense to me for the configuration guide to exist in the technical developer docs; a link from the Full Node guide should suffice for node operators who want to look under the hood.

Contributor

luke-jr commented Apr 7, 2015

Configuration is more end-user than technical IMO. Why not improve the existing wiki page?

Contributor

jlopp commented Apr 8, 2015

I think the average user doesn't configure their node much; the defaults work fine for most people. But there are 90+ configuration options that can come in handy for developers. Improving the wiki page would be nice, but I'd like to see the config options added as part of the comprehensive technical docs on bitcoin.org.

Contributor

luke-jr commented Apr 8, 2015

That the average user fails to configure their own node is a problem for Bitcoin because it centralises node policy on a set of defaults.

Contributor

harding commented Apr 8, 2015

@luke-jr centralized policy decisions are indeed a problem, but asking average users to spend at least several hours learning enough about Bitcoin so that they can make well-informed decisions about how to configure their own policy seems like a massively suboptimal solution. Surely there is way to encourage useful non-conformity without expecting network node operators to be experts.

Regarding Wiki versus GitHub, I haven't made up my mind. With Saïvann busy on other projects, my largish PRs to the dev docs are going unreviewed for a month or more at a time, so maybe it's time to consider doing more work on the Wiki where content can be posted without prior review.

Contributor

jlopp commented Apr 9, 2015

If you're being blocked because there is no one around to review your PRs, it sounds like we need to find some new people to review them. I'd be happy to help out if that's an option.

Contributor

saivann commented Apr 9, 2015

@jlopp Yes please, it's always very useful to have more reviewers!

@harding Please feel free to merge without waiting for too long for my reviews. I'll happily come back later and submit late pull requests if I find any issue. Thanks for your patience and I don't want to be blocking your nice work!

@harding harding added the Dev Docs label Apr 9, 2015

Contributor

harding commented Apr 9, 2015

@jlopp indeed, more reviewers are always massively appreciated. If there's anything we can do to make it easier for you to find and review just the stuff you're interested in, please let me know.

@saivann sorry, I didn't mean at all to imply that you were blocking my work! I was thinking more about the Wiki as an alternative source of reviewers. Posting new content to the Wiki, especially when there's already a Wiki page for the subject, could be a great way to attract reviewers---and some months later, I could always copy it back here.

@harding harding added the Core label Dec 29, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment