Commit Graph

98 Commits

Author SHA1 Message Date
habibitcoin
04a1160939
docs: remove $ from multiline commands or frequently copied [skip ci] 2022-10-28 12:32:24 -05:00
habibitcoin
0b1e881d18
scripted-diff: replace ⛰ emoji with $ [skip ci]
-BEGIN VERIFY SCRIPT-
sed -i 's/⛰/$/g' $(git grep -l '⛰')
-END VERIFY SCRIPT-
2022-10-28 12:06:49 -04:00
Thebora Kompanioni
a4ae57f9e9
fix: go version in ARMv6 section of INSTALL.md 2022-07-23 17:55:06 +02:00
Olaoluwa Osuntokun
c69138e00d
build: bump btcd, btcwallet and neutrino to latest versions 2022-06-08 11:40:50 -07:00
Daniel McNally
9966960b9a
build: update release tags
This updates the list of tags used for `release` builds in the release
documentation. `peersrpc`, `kvdb_postgres`, and `kvdb_etcd` are now
automatically included in `make release` or `make release-install`
builds.
2022-05-05 18:16:44 -04:00
Daniel McNally
d9654f429b
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.
2022-05-05 18:15:20 -04:00
Olaoluwa Osuntokun
d6b2283279
docs/INSTALL.md: update min Go version to 1.18
In this commit, we update the min Go version to be version 1.18. This
breaks our prior rule of supporting the last two major versions, but
allows us to use the larger features in 1.18 sooner, such as the newly
released type parameters.
2022-04-12 16:14:07 -07:00
gabbyprecious
fcc6fd267c docs: change docs for macaroon creation [skip ci] 2022-03-23 21:46:12 +01:00
Oliver Gugger
f0e2a20d67
Merge pull request #6181 from schjonhaug/general-improvements-to-mobile-instructions
General improvements to mobile instructions
2022-01-24 16:52:52 +01:00
Dimitris Apostolou
530a2059e5
multi: Fix typos [skip ci] 2022-01-24 12:19:02 +02:00
Andreas Schjønhaug
1f50320fe1 General improvements to mobile instructions
* Using <details> and <summary> tags in the INSTALL.md to collapse the various platforms for installing, making the rendered page shorter and easier to read.
* Simplyfying the instructions for creating LND mobile
* Fixed bug in checkout of latest tagged release
* Fixed bug in command for moving proto definitions to same folder as xcframework file
* Use Go 1.17.6 for building the Swift proto definitions
* Added link to LND Builder’s Guide
2022-01-22 09:23:48 +01:00
Rong Ou
a2d9814206
docs: fix typo 2022-01-11 14:08:19 +01:00
Torkel Rogstad
55617f153f lncli: add fish-completion
This is a new, hidden command that generates completions for Fish shell.
This can be piped into `source` or saved in a file to activate (almost)
perfect tab completion.
2021-12-13 11:07:49 +01:00
naveen
b3ef3db0f2
multi: Remove GO111MODULE env variable in Makefile
The `GO111MODULE` variable is not required from go 1.16
https://go.dev/blog/go116-module-changes
2021-11-30 09:35:30 +01:00
Olaoluwa Osuntokun
d6fc6f4960
docs: advertise Go 1.16 as min Go version in INSTALL.md 2021-09-29 17:31:40 -07:00
Martin Habovštiak
410b30b9ca docs: remove warning about pruned nodes
This removes a warning in the documentation saying that pruned nodes are
not supported. This is no longer the case as [pruning is supported since
0.13](https://github.com/lightningnetwork/lnd/pull/5154). So instead it
now says pruning is supported and notes the version and implications of
pruning.
2021-07-23 14:27:13 +02:00
maitrebitcoin
23baa75c09
docs/INSTALL.md: update command line to install go
you must be root to be able to install go on /usr/local/
without "sudo" the command fails with :
tar: go/src/cmd/go/main.go: Cannot open: No such file or directory
2021-05-31 13:06:09 -07:00
Oliver Gugger
d13fb16608
docs: add wallet management doc, fix markup in INSTALL doc
To give users an idea how the new auto-unlock flag can be used in a more
safe way than just writing the password to a file, we add a new wallet
management document and describe the unlock feature in detail.
2021-05-06 12:23:46 +02:00
Olaoluwa Osuntokun
a1bfbdc7d2
docs/INSTALL.md: update install docs w/ new min Go version 2021-04-13 15:57:27 -07:00
Oliver Gugger
2c634bfaf3
docs: unify code and shell cmd blocks 2021-01-22 09:14:09 +01:00
Oliver Gugger
5b8a3eb72f
doc: update INSTALL.md, recommend installing releases
To prevent novice users from running non-release versions, we update the
installation instructions to point them towards our release binaries.
We also document the new Docker build helper that allows you to compile
lnd without needing to install golang.
2021-01-11 10:21:03 +01:00
Alex Bosworth
3786c82daf
docs: Add mention of support for Neutrino
Neutrino will now work out of the box in LND
2020-11-16 10:28:46 -08:00
Conner Fromknecht
e135047304
Merge pull request #4353 from LN-Zap/feat/neutrino-user-agent
Ability to configure neutrino useragent
2020-09-23 16:45:19 -07:00
Glen Cooper
a9673a408d
Update INSTALL.md
latest version of Go has increase from 1.13 to 1.15
2020-08-15 09:55:27 +00:00
Jake Sylvestre
678e5c5736 chore: Update minimum golang version to 1.13 2020-07-28 19:46:52 -04:00
Olaoluwa Osuntokun
52084d1bae
docs: update install docs to no longer use go get
Fixes #4444.
2020-07-07 15:56:24 -07:00
Tom Kirkpatrick
bafab33beb
lnd: expose user agent version as config option
Expose the neutrino `UserAgentVersion` config option. This can be set
by starting lnd with the `--neutrino.useragentversion=` flag.
2020-06-04 13:12:08 +02:00
Tom Kirkpatrick
4394cc39af
lnd: expose user agent name as config option
Expose the neutrino `UserAgentName` config option. This can be set by
starting lnd with the `--neutrino.useragentname=` flag.
2020-06-04 13:10:36 +02:00
yyforyongyu
97da7b3444 multi: support config bitcoind fee estimate mode 2020-03-25 14:59:23 +08:00
Oliver Gugger
2b163480cf
docs: bitcoind is required for unit tests 2019-11-06 09:47:48 +01:00
Olaoluwa Osuntokun
6691c039ec
docs: update docs to build using go 1.13 2019-09-11 05:56:47 -07:00
Spencer Dupre
e2d5825df0 docs: update INSTALL.md to include first wallet creation (#3403)
Add 'Creating a wallet' section, explaining that 'lncli create' must be run
with a new instance. Also describe the password prompt and mnemonic this
command presents to the user.
2019-09-09 02:37:23 -07:00
Philipp Gille
c99c1f59f3 docs: update Go version from 1.11 to 1.12
- Also changed "go" to "Go" when used as a name
- Also changed "http" to "https" for two URLs that support HTTPS
2019-04-10 21:15:18 +02:00
Thomas Braunberger
fab742141f fix links to BIP 157 and 158 2019-02-27 10:01:34 +01:00
Gfloresechaiz
02617875c0
Update INSTALL.md 2019-02-20 19:30:23 -05:00
Olaoluwa Osuntokun
c3ebe6c77d
Merge pull request #2402 from Roasbeef/update-install-directions
docs/INSTALL.md: update Go installation options for Linux
2019-01-17 16:33:06 -08:00
Web Worker
697217630e
Fix TOC link 2019-01-04 12:37:52 -05:00
Olaoluwa Osuntokun
d8a991ee68
docs/INSTALL.md: pin brew install against go 1.11 2019-01-02 15:14:46 -08:00
Olaoluwa Osuntokun
11dac33c6f
docs/INSTALL.md: update Go installation options for Linux
In this commit, we modify the Linux installation instructions to use the
pre-built archives rather than install from the ppa. We do this as
typically the ppa lags behind the latest releases, and also by
downloading it in this new manner, we're able to verify the sha256 sum
of the installed Go release.
2019-01-02 15:11:19 -08:00
Olaoluwa Osuntokun
c355acb59d
docs: revamp INSTALL.md
In this commit, we aim to revamp the `INSTALL.md` file in order to make
it easier to parse, and more explicit. We've added a table of contents
to allow users to skip down to relevant sections and obtain a snapshot
of the contents of the document. Additionally, we've now modified the
headings to express a more clear delineation of the various sections.
2018-12-13 13:54:23 -08:00
Olaoluwa Osuntokun
eda45adb5b
docs: update docs to reflect new go modules usage and building 2018-11-28 20:13:56 -08:00
Oscar Lafarga
832bd8101c docs: update INSTALL.md
- Provides clarity to the sample `lnd.conf` to reduce friction on a first-time mainnet set up of lnd (avoiding the `loadConfig: debug-htlc mode cannot be used on bitcoin mainnet` error)

- Removes `debughtlc` from the sample `lnd.conf` since it is not something most people would use anymore
- Adds link to `sample-lnd.conf` with proper line-wrapping
2018-10-29 15:39:35 -07:00
bob-333
c7bbc9e4b3
Update INSTALL.md
Every time I try to update lnd by following these instructions it fails. Most recently like this:

    $ make
     Compiling dependencies.
    dep ensure -v
    # Bringing vendor into sync
    grouped write of manifest, lock and vendor: failed to export github.com/lightninglabs/neutrino: fatal: failed to unpack tree object 838f7ba74d217d188efc223604bd280b4e3f0238
    : exit status 128
    Makefile:116: recipe for target 'dep' failed
    make: *** [dep] Error 1

I found that if I `make clean` before running `make` then it doesn't fail.
2018-10-09 09:39:35 -07:00
Olaoluwa Osuntokun
233246714d build+docs: bump to golang 1.11 2018-10-07 11:28:49 +09:00
Conner Fromknecht
e47412be3a
docs/INSTALL: remove noencryptwallet from install docs
We will be slowly phasing this out, though abruptly
discontinuing support would be a more extensive change.
For now, we will ensure that this feature is not
recommended to users setting up a new wallet.
2018-09-04 20:52:43 -07:00
Wilmer Paulino
dc3db4bf62 docs: update path to where macaroons are stored
Co-Authored-By: Karl Ranna <karl@karlranna.com>
2018-08-23 18:05:00 -07:00
Wilmer Paulino
41379c9c73
docs: fix lnd w/ bitcoind backend example command 2018-08-09 23:54:47 -07:00
Wilmer Paulino
e58486b599
docs: note that different ZMQ sockets must be used with bitcoind 2018-08-08 20:26:31 -07:00
Olaoluwa Osuntokun
a34a4661e8
docs: update installation instructions to point to btcsuite/btcd not roasbeef/btcd 2018-07-13 17:08:46 -07:00
Olaoluwa Osuntokun
6f60f139f4 multi: switch over import paths from roasbeef/* to btcsuite/* 2018-07-13 17:05:39 -07:00