Skip to content

Commit cf087aa

Browse files
committed
docs: add frozen for uv sync
prevent updates to lock file which might leave working directory dirty resulting in a modded cln version build
1 parent fd6f924 commit cf087aa

1 file changed

Lines changed: 20 additions & 20 deletions

File tree

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

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ If you're on a different distribution or OS, you can compile the source by follo
2929

3030
# Docker
3131

32-
To install the Docker image for the latest stable release:
32+
To install the Docker image for the latest stable release:
3333

3434
```shell
3535
docker pull elementsproject/lightningd:latest
@@ -123,8 +123,8 @@ If you want to build the Rust plugins (cln-grpc, clnrest, cln-bip353 and wss-pro
123123
sudo apt-get install -y cargo rustfmt protobuf-compiler
124124
```
125125

126-
> 📘
127-
>
126+
> 📘
127+
>
128128
> If your build fails because of your Rust version, you might want to check out [rustup](https://rustup.rs/) to install a newer version
129129
130130

@@ -133,20 +133,20 @@ There are two ways to build core lightning, and this depends on how you want use
133133
To build CLN for production:
134134

135135
```shell
136-
uv sync --all-extras --all-groups
136+
uv sync --all-extras --all-groups --frozen
137137
./configure
138138
RUST_PROFILE=release uv run make
139139
sudo RUST_PROFILE=release make install
140140
```
141141

142-
> 📘
143-
>
142+
> 📘
143+
>
144144
> If you want to disable Rust because you don’t need it or its plugins (cln-grpc, clnrest, cln-bip353 or wss-proxy), you can use `./configure --disable-rust`.
145145
146146
To build CLN for development:
147147

148148
```shell
149-
uv sync --all-extras --all-groups
149+
uv sync --all-extras --all-groups --frozen
150150
./configure
151151
uv run make
152152
uv run make check VALGRIND=0
@@ -256,15 +256,15 @@ If you want to compile locally and fiddle with compile time options:
256256

257257
See `/usr/ports/net-p2p/c-lightning/Makefile` for instructions on how to build from an arbitrary git commit, instead of the latest release tag.
258258

259-
> 📘
260-
>
259+
> 📘
260+
>
261261
> Make sure you've set an utf-8 locale, e.g. `export LC_CTYPE=en_US.UTF-8`, otherwise manpage installation may fail.
262262
263263
Running lightning:
264264

265265
Configure bitcoind, if not already: add `rpcuser=<foo>` and `rpcpassword=<bar>` to `/usr/local/etc/bitcoin.conf`, maybe also `testnet=1`.
266266

267-
Configure lightningd: copy `/usr/local/etc/lightningd-bitcoin.conf.sample` to
267+
Configure lightningd: copy `/usr/local/etc/lightningd-bitcoin.conf.sample` to
268268
`/usr/local/etc/lightningd-bitcoin.conf` and edit according to your needs.
269269

270270
```shell
@@ -379,15 +379,15 @@ git checkout v24.05
379379
Build lightning:
380380

381381
```shell
382-
uv sync --all-extras --all-groups
382+
uv sync --all-extras --all-groups --frozen
383383
./configure
384384
uv run make
385385
```
386386

387387
Running lightning:
388388

389-
> 📘
390-
>
389+
> 📘
390+
>
391391
> Edit your `~/Library/Application\ Support/Bitcoin/bitcoin.conf`to include `rpcuser=<foo>` and `rpcpassword=<bar>` first, you may also need to include `testnet=1`.
392392
393393
```shell
@@ -440,7 +440,7 @@ Launch Core Lightning:
440440

441441
## To cross-compile for Android
442442

443-
Make a standalone toolchain as per <https://developer.android.com/ndk/guides/standalone_toolchain.html>.
443+
Make a standalone toolchain as per <https://developer.android.com/ndk/guides/standalone_toolchain.html>.
444444
For Core Lightning you must target an API level of 24 or higher.
445445

446446
Depending on your toolchain location and target arch, source env variables such as:
@@ -465,8 +465,8 @@ make clean -C ccan/ccan/cdump/tools \
465465
&& make CC=clang -C ccan/ccan/cdump/tools
466466
```
467467

468-
Install the `qemu-user` package.
469-
This will allow you to properly configure the build for the target device environment.
468+
Install the `qemu-user` package.
469+
This will allow you to properly configure the build for the target device environment.
470470
Build with:
471471

472472
```shell
@@ -493,8 +493,8 @@ export LD=$target_host-ld
493493
export STRIP=$target_host-strip
494494
```
495495

496-
Install the `qemu-user` package. This will allow you to properly configure the
497-
build for the target device environment.
496+
Install the `qemu-user` package. This will allow you to properly configure the
497+
build for the target device environment.
498498
Config the arm elf interpreter prefix:
499499

500500
```shell
@@ -538,7 +538,7 @@ For all the other Pi devices out there, consider using [Armbian](https://www.arm
538538

539539
You can compile in `customize-image.sh` using the instructions for Ubuntu.
540540

541-
A working example that compiles both bitcoind and Core Lightning for Armbian can
541+
A working example that compiles both bitcoind and Core Lightning for Armbian can
542542
be found [here](https://github.com/Sjors/armbian-bitcoin-core).
543543

544544
## To compile for Alpine
@@ -582,6 +582,6 @@ apk add libgcc libsodium sqlite-libs zlib
582582

583583
## Python plugins
584584

585-
Python plugins will be installed with the `poetry install` step mentioned above fron development setup.
585+
Python plugins will be installed with the `poetry install` step mentioned above fron development setup.
586586

587587
Other users will need some Python packages if python plugins are used. Unfortunately there are some Python packages which are not packaged in Ubuntu, and so force installation will be needed (Flag `--user` is recommended which will install them in user's own .local directory, so at least the risk of breaking Python globally can be avoided!).

0 commit comments

Comments
 (0)