Commit Graph

133 Commits

Author SHA1 Message Date
Olaoluwa Osuntokun
a76affae91
docs: replace golint with make lint in contributor guidelines 2018-12-18 20:59:56 -08:00
Olaoluwa Osuntokun
0d5eef4f30
docs: in contributor guidelines, use make check not go test 2018-12-18 20:59:54 -08:00
Olaoluwa Osuntokun
ce39910f96
docs: add section in contribution guidelines describing fixup commits 2018-12-18 20:59:53 -08:00
Olaoluwa Osuntokun
d1571badaf
docs: add section in contribution guidelines for unique lnd code style 2018-12-18 20:59:52 -08:00
Olaoluwa Osuntokun
0dc9b35a1a
docs: add section in testing pointing towards Makefile docs 2018-12-18 20:59:51 -08:00
Olaoluwa Osuntokun
516a48741f docs: update contribution guidelines to add section on commit structure 2018-12-18 20:59:46 -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
Olaoluwa Osuntokun
e6c22d658d
docs: update contribution guidelines to reference latest version of Go
with '#' will be ignored, and an empty message aborts the commit.
2018-11-28 20:13:50 -08:00
Olaoluwa Osuntokun
f09a4daeb1
docs/MAKEFILE: remove obsolete travis section
In this commit, we remove the travis section as the directive has been
removed from the makefile.
2018-11-28 20:13:49 -08:00
Olaoluwa Osuntokun
ca28c0b5a1
docs/MAKEFILE: remove dep section
In this commit, we remove the dep section as we no longer use it, and
instead use go modues.
2018-11-28 20:13:48 -08:00
Carlos Garcia Ortiz
0f03120a46 Docs: code_contribution_guidelines change link 2018-11-27 10:20:06 +01:00
Xavi Soler
ca9f572766 add num_inactive_channels field to docs 2018-11-05 09:11:01 +01:00
Johan T. Halseth
08c2ee05f6
Merge pull request #2107 from vwoo/grpc-ruby-doc-macaroon
gRPC ruby doc updates
2018-10-31 08:26:56 +01: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
Olaoluwa Osuntokun
3b9aa2e7b5
Merge pull request #2053 from BobleChinois/docs/configuring_tor
update 'configuring_tor' file
2018-10-26 17:13:09 -07:00
Vincent Woo
8103db60de Show how macaroon interceptor can work with streaming gRPC in Ruby doc 2018-10-26 14:17:35 -07:00
Vincent Woo
6dd4fde56a Fix incorrect hash key in gRPC Ruby documentation 2018-10-26 13:24:30 -07:00
Boblechinois
5aad6768b3 update 'configuring_tor' file 2018-10-15 14:25:12 +02: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
3fda1029c0
Merge pull request #1786 from Roasbeef/golang-1.1
build+docs: bump to golang 1.11
2018-10-08 13:26:07 +09:00
Olaoluwa Osuntokun
233246714d build+docs: bump to golang 1.11 2018-10-07 11:28:49 +09:00
Conner Fromknecht
c2d9cb11d3
docs/MAKEFILE: add log params to unit test targets 2018-10-05 13:04:45 +09:00
Olaoluwa Osuntokun
6afee3d099
Merge pull request #1856 from maurycy/typos
multi: fix various typos in comments
2018-09-27 20:38:10 -07:00
Olaoluwa Osuntokun
c5ece1e509
Merge pull request #1843 from cfromknecht/change-noencryptwallet
Start deprecating noencryptwallet
2018-09-12 21:07:23 -07:00
Wilmer Paulino
18528e9f3f
docs: update v3 tor docs 2018-09-11 19:37:13 -07:00
maurycy
ac24b12bf2
multi: fix various typos in comments 2018-09-07 06:51:49 +02: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
Conner Fromknecht
a3acd9c23f
docs/INSTALL: fix mismatched code blocks 2018-07-10 19:03:06 -07:00
Dan Bolser
d0d77f9718 README: add known good FreeBSD (9.11) instructions 2018-07-10 16:53:34 -07:00
Matthew Lilley
c571b04236 Add make instructions for Windows WSL users 2018-06-30 00:48:31 +01:00
Brenden Matthews
c703418d1a
docs: Add starter doc on debugging lnd. 2018-06-25 16:27:58 -04:00
Olaoluwa Osuntokun
fc658dbf60
docs: further clarify --txindex usage for full nodes 2018-06-18 14:01:25 +01:00
Dan Bolser
b5d8cde6fc README: update README to indicate tx index is no longer required for full node backends 2018-06-18 05:58:24 -07:00
Wilmer Paulino
c1886d2c1c
docs: add NAT traversal related documentation 2018-06-12 18:40:13 -07:00
Wilmer Paulino
5b58d24f78
docs: update documentation for inbound connections 2018-06-04 20:41:47 -07:00
Rudy Godoy
3ee4f5fbd4 docs/docker: fixed link to /docker/README.md
Link must be /docker/README.md, relative to the repository's root. Previously it was relative to /docs, resulting in 404.
2018-06-04 16:13:17 -07:00
Jack McCallum
42de4400bf docs/grpc: add macaroon and SSL Cipher info to Ruby gRPC docs 2018-05-24 19:15:23 -07:00
Alex
1969022cec docs/INSTALL: update docs with more detailed info for ZMQ support 2018-05-22 17:31:05 -07:00
Oliver Gugger
3eff9804ee macaroons: add technical documentation, fix comments 2018-05-18 10:13:25 +02:00
tyzbit
fbc722147f lnd+docker: add "Production" Docker Image
This commit satisfies the auto-build functionality desired in #722 without changing anything in the docker folder. This allows development and testing to continue to build and use images locally, but external users get a very lean Docker image they can use. The size difference is appreciable.

REPOSITORY                     TAG                 IMAGE ID            CREATED             SIZE
lnd                            latest              3634dcf5df68        17 seconds ago      1.19GB
lnd-single                     latest              b295cc248447        30 minutes ago      56MB
Right before merging this PR, an Automated Build repository should be configured on the appropriate account (lightningnetwork?) on Docker Hub with the name of lnd in order to match documentation.

I see there are already some repositories created, however I think best practice for Docker is to have a single repository and different tags for different architectures. The included image is based off of Alpine, but in the future we could extend into multiple Dockerfiles (example: ARM support, or being Ubuntu based).

So in this proposed scenario, lightningnetwork/lnd:latest would be alpine, but lightningnetwork/lnd:ubuntu would be an ubuntu-based image, for example.

(With thanks to @alingenhag for https://github.com/f-u-z-z-l-e/docker-lnd/ from which I borrowed heavily)
2018-05-16 18:50:25 -07:00
tyzbit
c96d07c1ae docs: add note about bitcoind with multiple lnd instances 2018-05-14 15:59:10 -07:00
Jasper
cc494bd47f docs/INSTALL: update non-make installation to include lncli
The make file contains installing lncli, which has to be installed 
manually when not using make.
2018-05-14 15:56:36 -07:00
Olaoluwa Osuntokun
27ca61aedf
Merge pull request #1196 from guggero/contribution-guideline
docs: add line wrap to contribution checklist
2018-05-07 21:37:44 -07:00
Max Vernon
a126c91745 docs/INSTALL: add advice for using 127.0.0.1 for bitcoind backend on Windows (#1195)
Using localhost to connect lnd to bitcoind on Windows is very slow.  Use 127.0.0.1 instead.
2018-05-07 21:29:20 -07:00