From d9654f429b7a5209bd736f7dbb8de2a7ceed424b Mon Sep 17 00:00:00 2001 From: Daniel McNally Date: Sat, 30 Apr 2022 15:25:56 -0400 Subject: [PATCH] docs/INSTALL.md: add list of build tags This adds a list of tags that can be used when building or installing lnd from source. Links to relevant code, protobuf definitions, or documentation are included to illustrate the purpose of each tag. Closes #3598. --- docs/INSTALL.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/INSTALL.md b/docs/INSTALL.md index 5c16680d5..2f7a0d53b 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -238,6 +238,32 @@ used directly: ⛰ go install -v ./... ``` +**Tags** + +Release binaries and installations from source using `make release-install` +will have the following tags: + +- [autopilotrpc](/lnrpc/autopilotrpc/autopilot.proto) +- [signrpc](/lnrpc/signrpc/signer.proto) +- [walletrpc](/lnrpc/walletrpc/walletkit.proto) +- [chainrpc](/lnrpc/chainrpc/chainnotifier.proto) +- [invoicesrpc](/lnrpc/invoicesrpc/invoices.proto) +- [routerrpc](/lnrpc/routerrpc/router.proto) +- [watchtowerrpc](/lnrpc/watchtowerrpc/watchtower.proto) +- [monitoring](/monitoring) (for Prometheus integration) +- [peersrpc](/lnrpc/peersrpc/peers.proto) +- [kvdb_postrgres](/docs/postgres.md) +- [kvdb_etcd](/docs/etcd.md) + +The `dev` tag is used for development builds, and is not included in the +release builds & installation. + +You can specify a custom set of tags when installing from source using the `tags=""` parameter. For example: + +```shell +make install tags="signrpc walletrpc routerrpc invoicesrpc" +``` + **Updating** To update your version of `lnd` to the latest version run the following