Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 16 additions & 14 deletions doc/getting-started/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,23 +70,22 @@ You will also need a version of bitcoind with segregated witness and `estimatesm

## To Build on Ubuntu

OS version: Ubuntu 15.10 or above
OS version: Ubuntu 22.04 or above

Get dependencies:
```shell
sudo apt-get update
sudo apt-get install -y \
jq autoconf automake build-essential git libtool libsqlite3-dev libffi-dev \
python3 python3-pip net-tools zlib1g-dev libsodium-dev gettext lowdown
pip3 install --upgrade pip
sudo apt update
sudo apt install -y \
curl autoconf jq libsecp256k1-dev libsodium-dev automake build-essential git libtool libsqlite3-dev libffi-dev python3 python3-pip net-tools zlib1g-dev gettext pkg-config libssl-dev lowdown python3-mako
curl -LsSf https://astral.sh/uv/install.sh | sh
```
If installation halts on tzdata configuration, finish the setup of your OS and try again.

After installing uv, restart your shell or run `source ~/.bashrc` to ensure `uv` is in your PATH.
After installing uv, restart your shell or run `source ~/.local/bin/env` to ensure `uv` is in your PATH.

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).
```shell
sudo apt-get install snapd
sudo apt install snapd
sudo snap install bitcoin-core
# Snap does some weird things with binary names; you'll
# want to add a link to them so everything works as expected
Expand All @@ -101,23 +100,26 @@ cd lightning

Checkout a release tag:
```shell
git checkout v25.02
git checkout v26.06
```

For development or running tests, get additional dependencies:
```shell
sudo apt-get install -y valgrind libpq-dev shellcheck cppcheck \
libsecp256k1-dev lowdown
sudo apt install -y valgrind libpq-dev shellcheck cppcheck
```

If you want to build the Rust plugins (cln-grpc, clnrest, cln-bip353 and wss-proxy):
If you want to build the Rust plugins (cln-grpc, clnrest, cln-bip353 and wss-proxy) make sure that you have Rust 1.85+ installed (included on Ubuntu 25.10 or higher):

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would still like a link to https://rustup.rs/ so users on ubuntu <25.10 know how to get it.

```shell
sudo apt-get install -y cargo rustfmt protobuf-compiler
sudo apt install -y cargo rustfmt
```

> 📘
>
> If your build fails because of your Rust version, you might want to check out [rustup](https://rustup.rs/) to install a newer version
> For Ubuntu <25.10, all details about installing Rust can be found at https://rustup.rs/.
> In any case, Rust plugins require protocol buffers:
```shell
sudo apt install -y protobuf-compiler
```

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

Expand Down
Loading