Skip to content

Commit 3128fd3

Browse files
committed
docs: Update install docs for v25.02
Also removes usage of pip due to this error that crops up on newer versions of Ubuntu: ``` error: externally-managed-environment × This environment is externally managed ╰─> To install Python packages system-wide, try apt install python3-xyz, where xyz is the package you are trying to install. If you wish to install a non-Debian-packaged Python package, create a virtual environment using python3 -m venv path/to/venv. Then use path/to/venv/bin/python and path/to/venv/bin/pip. Make sure you have python3-full installed. If you wish to install a non-Debian packaged Python application, it may be easiest to use pipx install xyz, which will manage a virtual environment for you. Make sure you have pipx installed. See /usr/share/doc/python3.12/README.venv for more information. note: If you believe this is a mistake, please contact your Python installation or OS distribution provider. You can override this, at the risk of breaking your Python installation or OS, by passing --break-system-packages. hint: See PEP 668 for the detailed specification. ``` I've been recommending installing Poetry from the official installer for the past several months and it always works. Changelog-None
1 parent deae922 commit 3128fd3

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

doc/getting-started/getting-started/installation.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ See all of the docker images for Core Lightning on [Docker Hub](https://hub.dock
4444

4545
# Third-party apps
4646

47-
For a GUI experience, you can install and use Core Lightning via a variety of third-party applications such as [Ride the Lightning](https://www.ridethelightning.info/), [Umbrel](https://getumbrel.com/), [BTCPayServer](https://btcpayserver.org/), [Raspiblitz](https://raspiblitz.org/), [Embassy](https://start9.com/).
47+
For a GUI experience, you can install and use Core Lightning via a variety of third-party applications such as [Ride the Lightning](https://www.ridethelightning.info/), [Umbrel](https://getumbrel.com/), [BTCPayServer](https://btcpayserver.org/), [Raspiblitz](https://raspiblitz.org/), and [Start9](https://start9.com/).
4848

4949
Core Lightning is also available on nixOS via the [nix-bitcoin](https://github.com/fort-nix/nix-bitcoin/) project.
5050

@@ -64,7 +64,7 @@ For actually doing development and running the tests, you will also need:
6464
- pip3: to install python-bitcoinlib
6565
- valgrind: for extra debugging checks
6666

67-
You will also need a version of bitcoind with segregated witness and `estimatesmartfee` with `ECONOMICAL` mode support, such as the 0.16 or above.
67+
You will also need a version of bitcoind with segregated witness and `estimatesmartfee` with `ECONOMICAL` mode support. Version 0.16 or above should work.
6868

6969
## To Build on Ubuntu
7070

@@ -81,6 +81,9 @@ pip3 install --upgrade pip
8181
pip3 install --user poetry
8282
```
8383

84+
(If installing `poetry` with `pip` as above fails, try installing it with the [official poetry installer](https://python-poetry.org/docs/#installing-with-the-official-installer).)
85+
86+
8487
If you don't have Bitcoin installed locally you'll need to install that as well. It's now available via [snapd](https://snapcraft.io/bitcoin-core).
8588

8689
```shell
@@ -101,7 +104,7 @@ cd lightning
101104
Checkout a release tag:
102105

103106
```shell
104-
git checkout v24.05
107+
git checkout v25.02
105108
```
106109

107110
For development or running tests, get additional dependencies:
@@ -114,33 +117,30 @@ pip3 install pytest
114117

115118
If you can't install `lowdown`, a version will be built in-tree.
116119

117-
If you want to build the Rust plugins (currently, cln-grpc):
120+
If you want to build the Rust plugins (currently cln-grpc and clnrest, which changed from Python to Rust as of v25.02):
118121

119122
```shell
120123
sudo apt-get install -y cargo rustfmt protobuf-compiler
121124
```
122125

123126
There are two ways to build core lightning, and this depends on how you want use it.
124127

125-
To build cln to just install a tagged or master version you can use the following commands:
128+
To build CLN for production:
126129

127130
```shell
128-
pip3 install --upgrade pip
129-
pip3 install mako
130-
pip3 install grpcio-tools
131+
poetry install
131132
./configure
132-
make
133+
poetry run make -j$(($(nproc)-1))
133134
sudo make install
134135
```
135136

136137
> 📘
137138
>
138-
> If you want disable Rust because you do not want use it or simple you do not want the grpc-plugin, you can use `./configure --disable-rust`.
139+
> If you want disable Rust because you do not want use it or you do not want `cln-grpc` or `clnrest`, you can use `./configure --disable-rust`.
139140
140-
To build core lightning for development purpose you can use the following commands:
141+
To build CLN for development:
141142

142143
```shell
143-
pip3 install poetry
144144
poetry shell
145145
```
146146

0 commit comments

Comments
 (0)