doc: add default bitcoin.conf locations #16621

pull GChuf wants to merge 1 commits into bitcoin:master from GChuf:patch-2 changing 1 files +10 −0
  1. GChuf commented at 2:34 PM on August 15, 2019: contributor

    Added default bitcoin.conf data directories and paths

  2. fanquake added the label Docs on Aug 15, 2019
  3. in doc/bitcoin-conf.md:58 in c34612bdff outdated 
      53 | +
  54 | +| Operating System | Data Directory | Path |
  55 | +| --- | --- | --- |
  56 | +| Windows | %APPDATA%\Bitcoin\ | *C:\Users\username\AppData\Roaming\Bitcoin\bitcoin.conf* |
  57 | +| Linux | $HOME/.bitcoin/ | */home/username/.bitcoin/bitcoin.conf* |
  58 | +| Mac OSX | $HOME/Library/Application Support/Bitcoin/ | */Users/username/Library/Application Support/Bitcoin/bitcoin.conf* |
    hebasto commented at 3:07 PM on August 15, 2019:

    s/Mac OSX/macOS/

    GChuf commented at 5:52 PM on August 15, 2019:

    ah, I see now - it's a "sed" command

  4. hebasto changes_requested
  5. hebasto commented at 3:07 PM on August 15, 2019: member

    Concept ACK

  6. in doc/bitcoin-conf.md:56 in c34612bdff outdated 
      48 | @@ -49,4 +49,12 @@ rpcport=4000
  49 |  
  50 |  The configuration file is not automatically created; you can create it using your favorite text editor. By default, the configuration file name is `bitcoin.conf` and it is located in the Bitcoin data directory, but both the Bitcoin data directory and the configuration file path may be changed using the `-datadir` and `-conf` command-line options.
  51 |  
  52 | +### Default configuration file locations
  53 | +
  54 | +| Operating System | Data Directory | Path |
  55 | +| --- | --- | --- |
  56 | +| Windows | %APPDATA%\Bitcoin\ | *C:\Users\username\AppData\Roaming\Bitcoin\bitcoin.conf* |
    practicalswift commented at 3:08 PM on August 15, 2019:

    Nit: Could drop italics for the path to make the back slashes look slightly less like forward slashes? :-)

  7. practicalswift commented at 3:09 PM on August 15, 2019: contributor

    Concept ACK

  8. GChuf commented at 5:26 PM on August 15, 2019: contributor

    Updated - dropped italics and changed mac OSX

  9. in doc/bitcoin-conf.md:54 in b8a5488183 outdated 
      48 | @@ -49,4 +49,12 @@ rpcport=4000
  49 |  
  50 |  The configuration file is not automatically created; you can create it using your favorite text editor. By default, the configuration file name is `bitcoin.conf` and it is located in the Bitcoin data directory, but both the Bitcoin data directory and the configuration file path may be changed using the `-datadir` and `-conf` command-line options.
  51 |  
  52 | +### Default configuration file locations
  53 | +
  54 | +| Operating System | Data Directory | Path |
    emilengler commented at 5:32 PM on August 15, 2019:

    Please remove the | at the left border, right border and you can also remove the spaces inbetween

    emilengler commented at 5:32 PM on August 15, 2019:

    See doc/files.md

    GChuf commented at 5:54 PM on August 15, 2019:

    I see. I copy-pasted a table and edited it from somewhere else in this repository.

  10. emilengler commented at 5:33 PM on August 15, 2019: contributor

    Concept ACK. Please take a look at this for a better markdown table syntax

  11. hebasto commented at 5:46 PM on August 15, 2019: member

    s/Mac OSX/macOS/ @gapeman ... and changed mac OSX

    Sorry for being misunderstood. I mean use macOS name only. See: release notes 0.18.

  12. GChuf commented at 6:55 PM on August 15, 2019: contributor

    Updated the table and macOS name. Having troubles with squashing commits.

    If it's possible to squash when merging, please do.

  13. in doc/bitcoin-conf.md:54 in ac621ce94e outdated 
      48 | @@ -49,4 +49,12 @@ rpcport=4000
  49 |  
  50 |  The configuration file is not automatically created; you can create it using your favorite text editor. By default, the configuration file name is `bitcoin.conf` and it is located in the Bitcoin data directory, but both the Bitcoin data directory and the configuration file path may be changed using the `-datadir` and `-conf` command-line options.
  51 |  
  52 | +### Default configuration file locations
  53 | +
  54 | +Operating System | Data Directory | Path
    practicalswift commented at 7:04 PM on August 15, 2019:

    Nit: Replace "Path" with "Example Path".

    promag commented at 11:27 PM on August 15, 2019:

    Why have Data Directory? Path is enough with env var.

    fanquake commented at 12:55 AM on August 16, 2019:

    I agree. We could just have macOS | $HOME/Library/Application Support/Bitcoin/. Especially since $HOME and /Users/username etc are the same thing. Seems a bit confusing to be using both.

    GChuf commented at 12:53 PM on August 16, 2019:

    some people don't know what environment variables are. I think it's best if we leave both examples

  14. in doc/bitcoin-conf.md:61 in ac621ce94e outdated 
      55 | +-- | -- | --
  56 | +Windows | %APPDATA%\Bitcoin\ | C:\Users\username\AppData\Roaming\Bitcoin\bitcoin.conf
  57 | +Linux | $HOME/.bitcoin/ | /home/username/.bitcoin/bitcoin.conf
  58 | +macOS | $HOME/Library/Application Support/Bitcoin/ | /Users/username/Library/Application Support/Bitcoin/bitcoin.conf
  59 | +
  60 |  The `includeconf=<file>` option in the `bitcoin.conf` file can be used to include additional configuration files.
    promag commented at 11:25 PM on August 15, 2019:

    This should belong to the previous section.

  15. promag commented at 11:31 PM on August 15, 2019: member

    This is partially documented in https://github.com/bitcoin/bitcoin/blob/master/doc/init.md, I think it's fine repeating it here.

  16. practicalswift commented at 12:58 PM on August 16, 2019: contributor

    Please squash to one commit :-)

    $ git checkout patch-2
$ git rebase -i HEAD~7
# mark all except first as "fixup"
$ git push -f
  17. GChuf closed this on Aug 16, 2019
  18. GChuf deleted the branch on Aug 16, 2019
  19. GChuf restored the branch on Aug 16, 2019
  20. GChuf reopened this on Aug 16, 2019
  21. GChuf commented at 2:23 PM on August 16, 2019: contributor

    I had all sorts of problems when squashing. Following @practicalswift instructions did not go well. head~7 was giving me last 12 commits or so, local branch was different from remote branch. Anyway, i'm new to git so sorry for all the mess. All should be fine now.

  22. GChuf commented at 1:11 AM on August 18, 2019: contributor

    I think everything was addressed and this is ready to be merged, unless people have more proposals.

  23. in doc/bitcoin-conf.md:58 in d8781a74fe outdated 
      49 | @@ -50,3 +50,11 @@ rpcport=4000
  50 |  The configuration file is not automatically created; you can create it using your favorite text editor. By default, the configuration file name is `bitcoin.conf` and it is located in the Bitcoin data directory, but both the Bitcoin data directory and the configuration file path may be changed using the `-datadir` and `-conf` command-line options.
  51 |  
  52 |  The `includeconf=<file>` option in the `bitcoin.conf` file can be used to include additional configuration files.
  53 | +
  54 | +### Default configuration file locations
  55 | +
  56 | +Operating System | Data Directory | Example Path
  57 | +-- | -- | --
  58 | +Windows | %APPDATA%\Bitcoin\ | C:\Users\username\AppData\Roaming\Bitcoin\bitcoin.conf
    laanwj commented at 2:20 PM on August 19, 2019:

    Please escape these paths using backtips e.g. C:\Users\username\AppData\Roaming\Bitcoin\bitcoin.conf. I think this rendering is more appropriate, and also, otherwise, '\x will be seen as markdown escaping (this is why the letters have funky colors in the diff on github).

    GChuf commented at 4:37 PM on August 19, 2019:

    thank you, added backticks

  24. egp commented at 2:37 PM on August 19, 2019: none

    LGTM

  25. GChuf commented at 4:39 PM on August 19, 2019: contributor

    I took the liberty of adding one more line to the end of the file in the latest commit. I myself was struggling to find example bitcoin.conf file, so I think adding one more link to it might benefit someone.

  26. doc: add default bitcoin.conf locations
    Added default bitcoin.conf data directories and paths
Added example bitcoin.conf link
    1373fa7e3d
  27. DrahtBot commented at 5:49 AM on August 24, 2019: member

    <!--e57a25ab6845829454e8d69fc972939a-->

    The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

    <!--174a7506f384e20aa4161008e828411d-->

    Conflicts

    No conflicts as of last run.

  28. GChuf commented at 11:08 AM on August 25, 2019: contributor

    Kindly asking for this PR to be merged, only 10 lines were changed. Thanks

  29. ryanofsky approved
  30. ryanofsky commented at 4:44 PM on August 26, 2019: member

    ACK 1373fa7e3d3f04ce6938cdcd2124cba71ff82ca0

  31. practicalswift commented at 4:48 PM on August 26, 2019: contributor

    ACK 1373fa7e3d3f04ce6938cdcd2124cba71ff82ca0

  32. promag commented at 5:22 PM on August 26, 2019: member

    ACK

  33. hebasto commented at 5:56 PM on August 26, 2019: member

    To achieve consistency between docs and the code base, may I suggest to remove Windows XP (< Vista) datadir path from this comment: https://github.com/bitcoin/bitcoin/blob/adff8fe32101b2c007a85415c3ec565a7f137252/src/util/system.cpp#L686-L690 ?

    It could be just

    // Windows: C:\Users\username\AppData\Roaming\Bitcoin
// macOS: ~/Library/Application Support/Bitcoin
...
  34. GChuf commented at 12:14 AM on August 27, 2019: contributor

    Not sure about the Windows XP comment, I'll let the others chime in if they will.

  35. GChuf commented at 1:03 PM on August 28, 2019: contributor

    I suppose we should merge the PR as it is.

  36. fanquake approved
  37. fanquake commented at 3:36 AM on August 29, 2019: member

    ACK 1373fa7e3d3f04ce6938cdcd2124cba71ff82ca0 - Already three ACKs and lots of discussion here, so I'm going to merge, and the other comment

    https://github.com/bitcoin/bitcoin/blob/adff8fe32101b2c007a85415c3ec565a7f137252/src/util/system.cpp#L686-L690

    can be fixed later.

  38. fanquake referenced this in commit 9546a78595 on Aug 29, 2019
  39. fanquake merged this on Aug 29, 2019
  40. fanquake closed this on Aug 29, 2019
  41. sidhujag referenced this in commit e1d60c5d23 on Aug 29, 2019
  42. GChuf deleted the branch on Sep 5, 2019
  43. jasonbcox referenced this in commit 74c9bb0ed3 on Oct 15, 2020
  44. PastaPastaPasta referenced this in commit e3d9d85ae2 on Jun 27, 2021
  45. PastaPastaPasta referenced this in commit de48f33b5a on Jun 28, 2021
  46. PastaPastaPasta referenced this in commit e639982720 on Jun 29, 2021
  47. PastaPastaPasta referenced this in commit 1d676c5274 on Jul 1, 2021
  48. PastaPastaPasta referenced this in commit 9a390bf2d0 on Jul 1, 2021
  49. PastaPastaPasta referenced this in commit 05681e6820 on Jul 12, 2021
  50. PastaPastaPasta referenced this in commit 91d5b02582 on Jul 13, 2021
  51. DrahtBot locked this on Dec 16, 2021
Contributors
GChufhebastopracticalswiftemilenglerpromagfanquakelaanwjegpDrahtBotryanofsky
Labels
Docs
github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-04-22 18:14 UTC
This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me