From 3769fc24558d8d328cd6b1066e4ddc6619cd23b3 Mon Sep 17 00:00:00 2001 From: Leo Weese Date: Thu, 2 Jan 2025 21:17:11 +0000 Subject: [PATCH] GITBOOK-471: change request with no subject merged in GitBook --- lightning-network-tools/loop/get-started.md | 38 ++++++++------------- 1 file changed, 15 insertions(+), 23 deletions(-) diff --git a/lightning-network-tools/loop/get-started.md b/lightning-network-tools/loop/get-started.md index b672dda1..4d750ac5 100644 --- a/lightning-network-tools/loop/get-started.md +++ b/lightning-network-tools/loop/get-started.md @@ -1,39 +1,31 @@ --- -description: Install and run Loop +description: Install Loopd from source or the binaries --- -# 🛠 Get Started +# 🛠️ Get Started ## Install Loop -Loop comes bundled with [Lightning Terminal](../lightning-terminal/). Meaning, if you have Lightning Terminal installed, you can already access Loop through the command line and you may skip the step below. +Loop comes bundled with [Lightning Terminal](../lightning-terminal/) (`litd`). If you are already running `litd`, you can access Loop through the command line or the [Lightning Terminal UI](../lightning-terminal/connect.md) and may skip the steps below. -\[[Follow this guide to install Lightning Terminal](../lightning-terminal/get-lit.md)] +[Follow this guide to install Lightning Terminal](../lightning-terminal/get-lit.md) -To run Loop you need to be running LND from the [binary releases](https://github.com/lightningnetwork/lnd/releases), or compile from source with the command `make install tags="signrpc walletrpc chainrpc invoicesrpc"` +## Installation -You can run Loop directly from the binary releases, or compile it from source: +To run Loop you need to be running LND from the[ binary releases](https://github.com/lightningnetwork/lnd/releases), or compile from source with the command make install `tags="signrpc walletrpc chainrpc invoicesrpc"` -`git clone https://github.com/lightninglabs/loop.git`\ -`cd loop`\ -`make && make install` - -## Run Loop - -Loop, like bitcoind, LND and others, comes with two components: Loopd and a command line interface (CLI) to interact with it called loop. +### Run the Binary -You will need to first run Loop with the command `loopd` +You can run Loop directly from the binary releases, [which you can find here](https://github.com/lightninglabs/loop/releases). -If you want to run Loop in the background, you can also write the output to `/dev/null` by amending `&>/dev/null &` to the above command. +### Compile from source -### Lightning Terminal +You can compile Loop from source. This requires Golang. Instructions for how to install Go can be found in the [LND installation guide](../lnd/run-lnd.md). -If you are running Lightning Terminal already, either locally or remotely, Loop will be running inside of it already. You can make use of Loop using the Lightning Terminal GUI as explained in the Guide to Lightning Terminal. - -If you want to interact with Loop in Lightning Terminal through the command line, you will need to specify the port and tls.cert every time you run loop using the flag `--rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert`, for example `./loop --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.certquote in 500000` - -Alternatively you may also copy over the `tls.cert` from `~/.lit` into `~/.loop/mainnet` +`git clone https://github.com/lightninglabs/loop.git`\ +`cd loop`\ +`make && make install` -If you are a Lightning Terminal user and want to avoid having to include the `--rpcserver` command every time or navigate to the location of the loop binary, you may also add an entry to your aliases file (e.g. `~/.bash_aliases`): +## Configuration -`alias loop=’~/path/to/loop --rpcserver=localhost:8443’` +By default, the `loopd.conf` is placed in `~/.loop/mainnet/` If you are starting `loopd` on another network (e.g. `loopd --network=signet`), the configuration file is expected in the relevant directory (e.g. `~/.loop/signet`). You may also pass a custom directory with the `--configfile=` flag.