diff --git a/.gitignore b/.gitignore index 8a1a96d..3532d11 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ .cache env venv +.DS_Store diff --git a/docs/assets/macos-format-drive.png b/docs/assets/macos-format-drive.png new file mode 100644 index 0000000..5db3990 Binary files /dev/null and b/docs/assets/macos-format-drive.png differ diff --git a/docs/faq.md b/docs/faq.md index e69de29..d742563 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -0,0 +1,17 @@ +# Frequently Asked Questions + +> **Q:** What is the best way to run a full node? + +Start with running it on an available computer if possible. You can follow the [PC/Laptop Guide](/pc) to get started. + +> **Q:** How much money will I make running a full node? + +None. + +> **Q:** Is a pruned node a full node? + +Yes. + +> **Q:** Should I buy a Raspberry Pi to run a dedicated full node? + +Probably not, but many people have them lying around so it's a decent option if you have already have one one. diff --git a/docs/pc/hardware.md b/docs/pc/hardware.md new file mode 100644 index 0000000..426cbe3 --- /dev/null +++ b/docs/pc/hardware.md @@ -0,0 +1,9 @@ +# Hardware + +You will likely be able to run a Full Node on most semi-modern hardware. The requirements are not very high. + +You will need a drive with at least 1TB of storage available if you want to store the entire blockchain. + +I will also recommend that you use a modern SSD for the IBD as it will speed up the process significantly (Days vs Weeks). + +**Note:** I am working on collecting data on the ability of different hardware to run a Full Node. If you have any data to share, please let me know. diff --git a/docs/pc/index.md b/docs/pc/index.md index 84ac90e..85b6c4f 100644 --- a/docs/pc/index.md +++ b/docs/pc/index.md @@ -12,4 +12,4 @@ Cons: - Not always on - Consumes System Resources -For an in depth guide to running the bitcoin core client on your PC or laptop checkout the Full Node guide at bitcoin.org. +For an in depth guide to running the bitcoin core client on your PC or laptop checkout the [Full Node guide](https://bitcoin.org/en/full-node) at bitcoin.org. diff --git a/docs/bitcoin-clients.md b/docs/pc/linux.md similarity index 100% rename from docs/bitcoin-clients.md rename to docs/pc/linux.md diff --git a/docs/pc/macos.md b/docs/pc/macos.md new file mode 100644 index 0000000..77b6c22 --- /dev/null +++ b/docs/pc/macos.md @@ -0,0 +1,17 @@ +# Mac OS + +If you are using an external drive make sure to format your external drive as `Mac OS Extended (Journaled)` before syncing the blockchain. Formatting as `ExFAT` will likely cause errors. + +To format your drive open `Disk Utility` and select your external drive. Click `Erase` and select `Mac OS Extended (Journaled)`. + +![macos format drive](../assets/macos-format-drive.png) + +## Download Bitcoin Core + +Head over to the [Bitcoin Core download page](https://bitcoin.org/en/download) and download the latest version of Bitcoin Core for Mac OS. Make sure to choose the `arm64` version if you have a new m-series Mac. + +Install Bitcoin Core by dragging the application to your `Applications` folder. + +Right click on the Bitcoin Core icon and select `Open`. You will be prompted with a warning that the application is from an unidentified developer. Click `Open`. + +A welcome screen will appear and you will be asked to choose a location for the blockchain data. If you are using an external drive select your external drive. If you are using your internal drive you can choose the default location. diff --git a/docs/pc/windows.md b/docs/pc/windows.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/resources.md b/docs/resources.md index fcad16f..6fc6ad5 100644 --- a/docs/resources.md +++ b/docs/resources.md @@ -2,15 +2,24 @@ Clients: -- [Bitcoin Core]() -- [Bitcoin Knots]() +- [Bitcoin Core](https://bitcoincore.org/) +- [Bitcoin Knots](https://bitcoinknots.org/) Other Guides: -- [Raspibolt]() -- [RaspiBlitz](https://docs.raspiblitz.org/docs/setup/software-setup/download) -- [Minibolt]() +- [Raspibolt](https://raspibolt.org/) +- [RaspiBlitz](https://raspiblitz.org/) +- [Minibolt](https://minibolt.info/) + +Wallets: + +- [Sparrow Wallet](https://sparrowwallet.com/) Hardware Wallets: -- [Coldcard]() +- [Coldcard](https://coldcard.com/) + +Forums: + +- [Bitcointalk](https://bitcointalk.org/) +- [Stacker News](https://stacker.news/) diff --git a/docs/why-run-a-node.md b/docs/why.md similarity index 100% rename from docs/why-run-a-node.md rename to docs/why.md diff --git a/mkdocs.yml b/mkdocs.yml index 08e736a..ceec72f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,8 +2,7 @@ nav: - Home: - Introduction: index.md - - Why Run a Node?: why-run-a-node.md - - Bitcoin Clients: bitcoin-clients.md + - Why Run a Node?: why.md - Resources: resources.md - FAQ: faq.md