e83782f5de
This PR: - adds all the guides (in markdown format) that is published at https://docs.corelightning.org/docs - adds a github workflow to sync any future changes made to files inside the guides folder - does not include API reference (json-rpc commands). Those will be handled in a separate PR since they're used as manpages and will require a different github workflow Note that the guides do not exactly map to their related files in doc/, since we reorganized the overall documentation structure on readme for better readability and developer experience. For example, doc/FUZZING.md and doc/HACKING.md#Testing are merged into testing.md in the new docs. As on the creation date of this PR, content from each of the legacy documents has been synced with the new docs. Until this PR gets merged, I will continue to push any updates made to the legacy documents into the new docs. If this looks reasonable, I will add a separate PR to clean up the legacy documents from doc/ (or mark them deprecated) to avoid redundant upkeep and maintenance. Changelog-None
2 KiB
| title | slug | excerpt | hidden | createdAt | updatedAt |
|---|---|---|---|---|---|
| Set up your node | getting-started | This guide will help you set up a Core Lightning node. You'll be up and running in a jiffy! | false | 2022-11-07T15:26:37.081Z | 2023-02-22T06:00:15.160Z |
The Core Lightning implementation has been in production use on the Bitcoin mainnet since early 2018, with the launch of the Blockstream Store. We recommend getting started by experimenting on testnet (or regtest), but the implementation is considered stable and can be safely used on mainnet.
The following steps will get you up and running with Core Lightning:
1. Prerequisites
-
Operating System
Core Lightning is available on Linux and macOS. To run Core Lightning on Windows, consider using docker.
-
Hardware
The requirements to run a Core Lightning node, at a minimum, are 4 GB RAM, ~500 GB of storage if you're running a Bitcoin Core full node, or less than 5 GB of storage if you run a pruned Bitcoin Core node or connect to Bitcoin Core remotely. Finally, a trivial amount of reliable network bandwidth is expected.
For a thorough understanding of the best hardware setup for your usage / scenario, see guidance at hardware considerations.
-
Bitcoin Core
Core Lightning requires a locally (or remotely) running
bitcoind(version 0.16 or above) that is fully caught up with the network you're running on, and relays transactions (ie withblocksonly=0). Pruning (prune=noption inbitcoin.conf) is partially supported, see here for more details. You can also connect your Core Lightning node to a remotely running Bitcoin Core, see here to learn how.