Skip to content

Commit 3e0f23b

Browse files
king-11rustyrussell
authored andcommitted
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 2d2a1c6 commit 3e0f23b

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

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
@@ -129,8 +129,8 @@ If you want to build the Rust plugins (cln-grpc, clnrest, cln-bip353 and wss-pro
129129
sudo apt-get install -y cargo rustfmt protobuf-compiler
130130
```
131131

132-
> 📘
133-
>
132+
> 📘
133+
>
134134
> If your build fails because of your Rust version, you might want to check out [rustup](https://rustup.rs/) to install a newer version
135135
136136

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

141141
```shell
142-
uv sync --all-extras --all-groups
142+
uv sync --all-extras --all-groups --frozen
143143
./configure
144144
RUST_PROFILE=release uv run make
145145
sudo RUST_PROFILE=release make install
146146
```
147147

148-
> 📘
149-
>
148+
> 📘
149+
>
150150
> 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`.
151151
152152
To build CLN for development:
153153

154154
```shell
155-
uv sync --all-extras --all-groups
155+
uv sync --all-extras --all-groups --frozen
156156
./configure
157157
uv run make
158158
uv run make check VALGRIND=0
@@ -262,15 +262,15 @@ If you want to compile locally and fiddle with compile time options:
262262

263263
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.
264264

265-
> 📘
266-
>
265+
> 📘
266+
>
267267
> Make sure you've set an utf-8 locale, e.g. `export LC_CTYPE=en_US.UTF-8`, otherwise manpage installation may fail.
268268
269269
Running lightning:
270270

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

273-
Configure lightningd: copy `/usr/local/etc/lightningd-bitcoin.conf.sample` to
273+
Configure lightningd: copy `/usr/local/etc/lightningd-bitcoin.conf.sample` to
274274
`/usr/local/etc/lightningd-bitcoin.conf` and edit according to your needs.
275275

276276
```shell
@@ -385,15 +385,15 @@ git checkout v24.05
385385
Build lightning:
386386

387387
```shell
388-
uv sync --all-extras --all-groups
388+
uv sync --all-extras --all-groups --frozen
389389
./configure
390390
uv run make
391391
```
392392

393393
Running lightning:
394394

395-
> 📘
396-
>
395+
> 📘
396+
>
397397
> Edit your `~/Library/Application\ Support/Bitcoin/bitcoin.conf`to include `rpcuser=<foo>` and `rpcpassword=<bar>` first, you may also need to include `testnet=1`.
398398
399399
```shell
@@ -446,7 +446,7 @@ Launch Core Lightning:
446446

447447
## To cross-compile for Android
448448

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

452452
Depending on your toolchain location and target arch, source env variables such as:
@@ -471,8 +471,8 @@ make clean -C ccan/ccan/cdump/tools \
471471
&& make CC=clang -C ccan/ccan/cdump/tools
472472
```
473473

474-
Install the `qemu-user` package.
475-
This will allow you to properly configure the build for the target device environment.
474+
Install the `qemu-user` package.
475+
This will allow you to properly configure the build for the target device environment.
476476
Build with:
477477

478478
```shell
@@ -499,8 +499,8 @@ export LD=$target_host-ld
499499
export STRIP=$target_host-strip
500500
```
501501

502-
Install the `qemu-user` package. This will allow you to properly configure the
503-
build for the target device environment.
502+
Install the `qemu-user` package. This will allow you to properly configure the
503+
build for the target device environment.
504504
Config the arm elf interpreter prefix:
505505

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

545545
You can compile in `customize-image.sh` using the instructions for Ubuntu.
546546

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

550550
## To compile for Alpine
@@ -588,6 +588,6 @@ apk add libgcc libsodium sqlite-libs zlib
588588

589589
## Python plugins
590590

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

593593
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)