GlcoinCore/charge-lnd
1
0
Fork 0
mirror of https://github.com/accumulator/charge-lnd.git synced 2026-08-13 12:33:01 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

update INSTALL.md for venv based installs

Browse source
This commit is contained in:
Sander van Grieken 2023-12-06 12:13:58 +01:00
parent e3658d2295
commit daa1a83067
1 changed files with 11 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

17
INSTALL.md
View file

@ -23,18 +23,23 @@ If you need to change these defaults, please have a look at the usage parameters
Python and PIP should be made available on the system before installing from source.
The project and its dependencies can be installed by running (don't forget the last dot):
```
$ pip install -r requirements.txt .
```
On some systems using Python 3, use pip3 instead:
```
$ pip3 install -r requirements.txt .
```
When running the install as `root`, `charge-lnd` will be installed to `/usr/local/bin`. Otherwise `charge-lnd` will be installed to `$HOME/.local/bin`.
On newer systems [PEP-668](https://peps.python.org/pep-0668/) is enforced, you need to install to a virtual environment:
```
$ export CHARGE_LND_ENV=/opt/charge-lnd
$ python3 -m venv ${CHARGE_LND_ENV}
$ ${CHARGE_LND_ENV}/bin/pip3 install -r requirements.txt .
```
`charge-lnd` will be installed to `${CHARGE_LND_ENV}/bin`
## Install using docker image
If you don't want to install from source, you can use a pre-baked docker image.