Commit Graph

92 Commits

Author SHA1 Message Date
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
42de4400bf docs/grpc: add macaroon and SSL Cipher info to Ruby gRPC docs 2018-05-24 19:15:23 -07:00
1969022cec docs/INSTALL: update docs with more detailed info for ZMQ support 2018-05-22 17:31:05 -07:00
3eff9804ee macaroons: add technical documentation, fix comments 2018-05-18 10:13:25 +02:00
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
c96d07c1ae docs: add note about bitcoind with multiple lnd instances 2018-05-14 15:59:10 -07:00
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
27ca61aedf Merge pull request #1196 from guggero/contribution-guideline
docs: add line wrap to contribution checklist
2018-05-07 21:37:44 -07:00
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
45ccace41c docs: add line wrap to contribution checklist 2018-05-07 19:21:03 +03:00
dd60e9e720 docs: spell out go commands in case user doesn't have make
Fixes #1171.
2018-05-03 16:27:09 -07:00
caf8139750 docs/grpc: correct javascript macaroon example
Creating and adding metadata in single line resulted in null `metadata`
2018-04-25 13:38:39 -07:00
c8abeb46a5 docs: add symlink for go suggestion to INSTALL.md 2018-04-19 16:06:39 -07:00
7a50097dec docs: update Go version to 1.9 in Contribution Checklist (#1095)
According to install.md, the minimum version of Go supported at the 
moment is 1.9, so update the Go version referenced in Contribution 
Checklist to 1.9 as well.
2018-04-17 18:58:46 -07:00
3c73329912 docs/grpc/javascript: updated docs to include macaroon and cipher suites 2018-04-17 18:42:55 -07:00
f61a71b6fc docs/macaroons: add reference to invoice.macaroon 2018-04-12 17:25:52 -07:00
16c304a4c1 docs/grpc/python remove witness_only 2018-04-09 13:01:39 -07:00
93a5a92243 adding missing cd-to-path for upgrade instructions 2018-04-03 11:19:07 +02:00
000e77f36c docs+README: update docs to no longer imply that only btcd is support
In this commit, we modify the docs in order to clarify that both btcd
and bitcoind are supported as chain backends. Many users expressed
confusion as the old set of docs stated that we "require" my btcd fork,
rather than clarifying that *if* you want to use btcd, then you must use
my fork.
2018-04-02 16:19:21 -07:00
7bc9dbc3ea docs/MAKEFILE: Add default and all commands 2018-03-31 19:14:45 -07:00
872d06e035 docs/INSTALL: Update installation with Makefile cmds 2018-03-31 19:14:39 -07:00
9bf4bbb642 docs: encode macaroon in python grpc example
Previously `decode` was used incorrectly.
2018-03-22 22:41:33 -07:00
bd631a43bb docs: Update old link to networkHarness framework (#919) 2018-03-22 12:42:11 -07:00
7fe719f77f docs: add correct cipher suit to python grpc example 2018-03-20 17:54:19 -07:00
5ef0d4c8b9 docs: update python grpc examples to use python 3 syntax 2018-03-20 13:42:53 -07:00
55e882c058 docs: add macaroon usage examples to python docs 2018-03-20 13:38:30 -07:00
47329c9267 docs: inconsistent ZMQ port numbers in examples
The port numbers used in the ZMQ examples are inconsistent between:

- The initial explanation of ZMQ
```
They must be combined in the same ZMQ socket
  address (e.g. `--zmqpubrawblock=tcp://127.0.0.1:28332` and
  `--zmqpubrawtx=tcp://127.0.0.1:28332`).
```

- The sample bitcoin.conf
```
zmqpubrawblock=tcp://127.0.0.1:18501
zmqpubrawtx=tcp://127.0.0.1:18501
```

- The lnd command-line example:
```
lnd --bitcoin.active --bitcoin.testnet --debuglevel=debug --bitcoin.node=bitcoind --bitcoind.rpcuser=REPLACEME --bitcoind.rpcpass=REPLACEME --bitcoind.zmqpath=tcp://127.0.0.1:28332 --externalip=X.X.X.X
```

I changed the sample bitcoin.conf port numbers to 28332 so they match the rest of the examples.
2018-03-17 14:37:57 -07:00
b0c35d5f39 README: fix go bin path in INSTALL.md
FIxes #839.
2018-03-16 16:28:57 -07:00
c33645cc80 README: fixed a small typo on INSTALL.md
`bitciond` => `bitcoind`
2018-03-16 16:28:01 -07:00
fa3f80dfa9 docs/INSTALL: note addition of litecoind setup in docs 2018-03-14 16:57:43 -07:00
24f9b6a342 Merge pull request #802 from wilmerpaulino/glide-to-dep
build: switch from glide to dep for dependency management
2018-03-12 20:30:39 -07:00
c86e1b1a37 docs: update INSTALL.md to have Go 1.9 as min required version
Fixes #815.
2018-03-12 11:58:23 -07:00
da5381815e docs: update INSTALL.md to use dep for dependencies 2018-03-12 13:38:38 -04:00
9d34fa8c1e docs/grpc/ruby: fix incorrect documentation in ruby.md value to amt (#799) 2018-03-02 19:16:22 -08:00
37aa9759db docs: Add details to macaroon usage with GRPC. 2018-02-28 16:19:48 -05:00
eed0e9ac67 docs: Show macaroon usage with Java GRPC example. 2018-02-28 16:19:48 -05:00
5fd236c870 docs: update reason for using btcd fork
We require roasbeef's fork of btcd as it has the neutrino serving additions, but mainline btcd doesn't yet.
2018-02-23 15:27:23 -08:00
236d53785d docs: update docs to recommend golang 1.10 2018-02-19 17:44:03 -08:00
9709e5f31f Merge pull request #737 from Roasbeef/tor-docs
tor: add stream isolation, additional documentation, neutrino support
2018-02-18 15:28:53 -08:00
b8e1351cf3 multi: fix some recently introduced typos 2018-02-18 15:27:29 -08:00
4cba9dc8d3 docs: add new documentation for configuring lnd+tor 2018-02-09 12:16:16 -08:00
a93736d21e multi: comprehensive typo fixes across all packages 2018-02-06 19:11:11 -08:00
ea7efea645 docs: remove header from bitcoin conf doc example 2018-02-05 15:08:39 -08:00
fa478266fc docs: update INSTALL.md to provide sample bitcoin.conf 2018-02-03 14:57:05 -08:00
b4e280eb15 docs: update install.md to same content as on lighting-dev-site
It seems that at some point the installation docs of the
https://github.com/lightninglabs/lightning-dev-site/ was identical to
this file (without page navigation + next steps).

Seems that this commit did not get ported to this repo:
1ad7d3189d

In this PR the info for macaroons and noencryptwallet is copied over
from the above mentioned commit.
2018-01-28 16:57:05 -08:00
859ecbd300 Merge pull request #569 from wilmerpaulino/protobuf-docs
docs: clarify how to generate protobuf definitions
2018-01-27 18:43:12 -08:00
451aff896f docs: Updated install instructions using bitcoind 2018-01-27 16:44:18 -08:00
b6235a536b Merge pull request #587 from kingvest/master
docs/grpc: added instructions for writing gRPC clients in Ruby
2018-01-27 16:31:23 -08:00
ffbcf7db4f lncli: rename value to amt in addinvoice command 2018-01-27 14:52:46 -08:00
e4e6766746 Doc fix: typo in lnd/bitcoind arguments 2018-01-19 11:23:05 +01:00