Commit Graph

120 Commits

Author SHA1 Message Date
yohei okada
bd631a43bb docs: Update old link to networkHarness framework (#919) 2018-03-22 12:42:11 -07:00
Adrien Emery
7fe719f77f docs: add correct cipher suit to python grpc example 2018-03-20 17:54:19 -07:00
Adrien Emery
5ef0d4c8b9 docs: update python grpc examples to use python 3 syntax 2018-03-20 13:42:53 -07:00
Adrien Emery
55e882c058 docs: add macaroon usage examples to python docs 2018-03-20 13:38:30 -07:00
Andreas M. Antonopoulos
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
João Mesquita
b0c35d5f39 README: fix go bin path in INSTALL.md
FIxes #839.
2018-03-16 16:28:57 -07:00
Perdouille
c33645cc80 README: fixed a small typo on INSTALL.md
`bitciond` => `bitcoind`
2018-03-16 16:28:01 -07:00
Conner Fromknecht
fa3f80dfa9
docs/INSTALL: note addition of litecoind setup in docs 2018-03-14 16:57:43 -07:00
Olaoluwa Osuntokun
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
Naveen
c86e1b1a37 docs: update INSTALL.md to have Go 1.9 as min required version
Fixes #815.
2018-03-12 11:58:23 -07:00
Wilmer Paulino
da5381815e
docs: update INSTALL.md to use dep for dependencies 2018-03-12 13:38:38 -04:00
Alex Gessner
9d34fa8c1e docs/grpc/ruby: fix incorrect documentation in ruby.md value to amt (#799) 2018-03-02 19:16:22 -08:00
Brenden Matthews
37aa9759db
docs: Add details to macaroon usage with GRPC. 2018-02-28 16:19:48 -05:00
Brenden Matthews
eed0e9ac67
docs: Show macaroon usage with Java GRPC example. 2018-02-28 16:19:48 -05:00
Dave Kerr
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
Olaoluwa Osuntokun
236d53785d
docs: update docs to recommend golang 1.10 2018-02-19 17:44:03 -08:00
Olaoluwa Osuntokun
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
practicalswift
b8e1351cf3 multi: fix some recently introduced typos 2018-02-18 15:27:29 -08:00
Olaoluwa Osuntokun
4cba9dc8d3
docs: add new documentation for configuring lnd+tor 2018-02-09 12:16:16 -08:00
practicalswift
a93736d21e multi: comprehensive typo fixes across all packages 2018-02-06 19:11:11 -08:00
Yancy Ribbens
ea7efea645 docs: remove header from bitcoin conf doc example 2018-02-05 15:08:39 -08:00
Yancy Ribbens
fa478266fc docs: update INSTALL.md to provide sample bitcoin.conf 2018-02-03 14:57:05 -08:00
Andreas Tasch
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
Olaoluwa Osuntokun
859ecbd300
Merge pull request #569 from wilmerpaulino/protobuf-docs
docs: clarify how to generate protobuf definitions
2018-01-27 18:43:12 -08:00
Salman Ansari
451aff896f docs: Updated install instructions using bitcoind 2018-01-27 16:44:18 -08:00
Olaoluwa Osuntokun
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
Cristobal Griffero
ffbcf7db4f lncli: rename value to amt in addinvoice command 2018-01-27 14:52:46 -08:00
Deelight-fr
e4e6766746 Doc fix: typo in lnd/bitcoind arguments 2018-01-19 11:23:05 +01:00
Maarten Tutak
a8728ccb5b docs: add example of Java gRPC client 2018-01-18 12:47:54 +01:00
Alex
3da0e2011b docker, docs, sample-lnd.conf: update examples for new command-line options 2018-01-15 14:56:21 -08:00
kingvest
40ccc3f417
docs/grpc: added instructions for writing gRPC clients in Ruby
This commit adds a basic set of instructions for installing the necessary
gRPC dependencies to be able to drive `lnd` using Ruby.
2018-01-10 19:21:03 +01:00
Wilmer Paulino
e2af9a6897
docs: clarify how to generate protobuf definitions 2018-01-07 01:54:28 -05:00
Justus Kandzi
976655d172 docs: fix python example code issues 2018-01-03 18:09:00 +01:00
hackerrdave
ad40207126 provide formatting for lnd references 2018-01-03 11:39:35 +01:00
Ben Congdon
3f2f74bae7 docs: fix python path typo
`os.path.expanduser` is needed to evaluate paths relative to the user's home directory.
2017-12-13 15:32:25 -08:00
Tomas Susanka
d1e194fbc7 docs: note on golang-1.8-go bin path
The golang-1.8-go package puts binaries in /usr/lib/go-1.8/bin. A new user might find it confusing that go binary is missing in the path
2017-12-13 14:22:59 -08:00
Nalin Bhardwaj
965fcf5bd6
docs: Modify example WalletBalance responses 2017-12-04 05:34:48 +05:30
Dimitris Tsapakidis
9c145d4071 docs: fix typos
Multiple typos fixed in 4 documents.
2017-12-02 18:59:11 -08:00
Olaoluwa Osuntokun
03d2d098b4
docs: add new section for macaroons 2017-11-27 16:06:56 -08:00
34ro
a3a02495fe docs: fix tutorial link in INSTALL.md 2017-11-27 17:16:24 -06:00
Olaoluwa Osuntokun
4aeaf5aaa9
docs/go-fuzz: rename wirefuzz.md to README.md 2017-10-05 18:30:26 -07:00
nsa
1e62865cf9 docs: fuzzing with go-fuzz tutorial
This commit adds a tutorial on fuzzing with the go-fuzz library
into the docs folder. It includes an introduction to fuzzing,
setup and installation steps to run go-fuzz with lnd, tips to
generate a valid corpus for use with go-fuzz, and finally it
includes a small explanation of the test harness that was used
to find bugs in lnd.
2017-10-05 18:28:59 -07:00
Olaoluwa Osuntokun
a34bf6abea
docs: update INSTALL.md to pin min golang version at 1.8 2017-09-27 19:37:40 -07:00
Olaoluwa Osuntokun
4e48a8cb86
docs: update installation docs, specify min version
This commit updates the installation docs to specify the min golfing
version. Additionally, we ensure that users running on linux will
download the latest version of golfing from their ppa. Finally, we also
now link directly to the golfing page of pre-compiled binaries for
users that seek to grab the source directly from the official goading
website.

Fixes #263.
2017-08-24 14:09:29 -07:00
Chris Moore
493d7b53f6 docs: add 'git clone' line for btcd installation
The installation instructions for btcd were missing a 'git clone' command.
2017-08-24 14:02:31 -07:00
Olaoluwa Osuntokun
ae5afcf555
docs: update installation notes with neutrino info 2017-08-22 21:01:24 -07:00
Olaoluwa Osuntokun
2b411051e1
docs: update contribution guidelines with newest proto repos 2017-08-22 00:53:43 -07:00
Max Fang
9cd1168ebe docs: State example gRPC assumptions, add TLS grpc instructions 2017-08-14 17:51:41 -07:00
Max Fang
ab97fa7287 docs: Javascript gRPC streaming examples & complete guide 2017-08-14 17:51:41 -07:00
Max Fang
34d270398f docs: Make Python gRPC docs suitable as an independent guide 2017-08-14 17:51:41 -07:00
Max Fang
9f8378f4cf readme+docs: Consolidate installation docs 2017-08-14 17:51:41 -07:00
Olaoluwa Osuntokun
f39b7aaaf9
build: create parallel travis builds to isolate race condition tests
This commit modifies the travis build script, and our local test script
to ensure that the race condition builds are conducted in a parallel
build. After this commit two travis builds will be kicked off for each
push/commit: one that runs the race condition tests in isolation, and
another that runs the integration tests then the coverage tests.

In order to do the above cleanly, the integration tests are now guarded
behind a build flag. In order to run the integration tests, one now
needs to specify the `-tags rpctest` flag when running the `go test`
command.
2017-07-04 16:05:22 -07:00
Olaoluwa Osuntokun
424ccccc2f
docs: correct mistake in protoc version used 2017-06-07 16:52:58 -07:00
bryanvu
23c1926ff0 docs: fix entry for externalip
In order to specify multiple external IP addresses in the configuration
file, each IP address be on a separate line, preceded by “externalip=“.
2017-05-11 14:58:55 -07:00
Olaoluwa Osuntokun
99f6454677
docs: update installation documentation in light of recent multi-chain changes 2017-05-02 20:46:38 -07:00
Alex Akselrod
35c9a12a73 docs: fix port in sample lnd.conf
The testnet port for btcd's RPC server was incorrect.
2017-04-10 18:40:50 -07:00
Olaoluwa Osuntokun
157145df65
docs: revamp installation docs to note --externalip and auto RPC config 2017-04-01 20:14:27 +02:00
Olaoluwa Osuntokun
66192b79ab
doc: update INSTALL.md with latest btcd commit hash 2017-03-29 19:00:24 -07:00
Marty Jones
18052f9f19 multi: various formatting fixes after changes to Github flavored markdown 2017-03-27 16:20:31 -07:00
Michiel de Jong
39cf3a6df5 docs/install: explain what to do if btcd.conf not found 2017-02-28 19:32:28 -06:00
Olaoluwa Osuntokun
e96e83f5eb
docs/grpc: add additional links to node.js tutorial 2017-02-28 18:22:06 -06:00
François
b2aa45db03 docs/grpc: add instructions for writing gRPC clients in node.js
This commit adds a basic set of instructions for installing the necessary
gRPC dependencies to be able to drive `lnd` from node.js. In the future,
this section will be expanded with additional example
scripts/applications.
2017-02-28 18:13:55 -06:00
Olaoluwa Osuntokun
564d44f64f
docs/grpc: expand python docs w/ links to official protobuf+gRPC tutorial 2017-02-28 18:09:45 -06:00
Tim Akinbo
188e4d4bec docs/grpc: added instructions for writing gRPC clients in Python
This commit adds a basic set of instructions for installing the necessary
gRPC dependencies to be able to drive `lnd` using Python. In the future,
this section will be expanded with additional example
scripts/applications.
2017-02-28 17:52:23 -06:00
Olaoluwa Osuntokun
b4fff97d14
docs: specify protoc version and json_name usage 2017-02-27 21:04:52 -06:00
Trevin Hofmann
40c7bac3aa multi: fix a variety of typos throughout the repo 2017-01-17 17:02:56 -08:00
Olaoluwa Osuntokun
1e8a80170f
docs: update INSTALL.md with new btcd commit hash, correct instructions 2017-01-14 17:53:36 -08:00
Christopher Jämthagen
a9449b876c docs: minor fixes 2017-01-09 19:37:49 -08:00
Alex
e91c1b8136 docs: add installation instructions 2017-01-05 16:42:43 -08:00
Olaoluwa Osuntokun
97b9b2ff09
docs: add code contribution guidelines
This commit adds a document which outlines some of the traits desired
in future contributions to the daemon. It’s my hope that this document
will allow new contributors to quickly get up to speed on what is
desired in new contributions, possibly directly speeding up review
times.
2016-11-08 12:31:01 -08:00