Skip to content

Commit 0e92290

Browse files
author
openoms
committed
configure footer
1 parent db7f482 commit 0e92290

File tree

4 files changed

+91
-41
lines changed

4 files changed

+91
-41
lines changed

_config.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@
1414
# You can create any custom variable you would like, and they will be accessible
1515
# in the templates via {{ site.myvariable }}.
1616
title: Lightning Network Developers
17-
author: Max Fang
18-
17+
1918
description: > # this means to ignore newlines until "baseurl:"
2019
Developer resources and documentation for the Lightning Network Daemon.
2120
baseurl: "" # the subpath of your site, e.g. /blog

_includes/footer.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@
22

33
<div class="wrapper">
44

5-
<h2 class="footer-heading">{{ site.title | escape }}</h2>
6-
75
<div class="footer-col-wrapper">
86
<div class="footer-col footer-col-1">
97
<ul class="contact-list">
8+
<li>
109
<li>
1110
{% if site.author %}
1211
{{ site.author | escape }}

guides/docker.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -313,10 +313,10 @@ The `Faucet` node address can be found at the [Faucet Lightning Community webpag
313313

314314
```bash
315315
# Run "Alice" container and log into it:
316-
$ docker-compose up -d "alice"; docker exec -i -t "alice" bash
316+
$ docker-compose run -d --name alice lnd_btc; docker exec -i -t "alice" bash
317317

318318
# Connect "Alice" to the "Faucet" node:
319-
alice$ lncli --network=simnet connect <faucet_identity_address>@<faucet_host>
319+
alice$ lncli --network=testnet connect <faucet_identity_address>@<faucet_host>
320320
```
321321

322322
After a connection is achieved, the `Faucet` node should create the channel

guides/installation.md

Lines changed: 87 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ title: Installation
44

55
---
66

7-
# Table of Contents
87
* [Installation](#installation)
98
* [Preliminaries](#preliminaries)
109
* [Installing lnd](#installing-lnd)
@@ -18,10 +17,11 @@ title: Installation
1817
* [Running lnd using the btcd backend](#running-lnd-using-the-btcd-backend)
1918
* [Using Neutrino](#using-neutrino)
2019
* [Using bitcoind or litecoind](#using-bitcoind-or-litecoind)
20+
* [Creating a Wallet](#creating-a-wallet)
2121
* [Macaroons](#macaroons)
2222
* [Network Reachability](#network-reachability)
23-
* [Simnet vs. Testnet Development](#simnet-vs.-testnet-development)
24-
* [Creating an lnd.conf (Optional)](#creating-an-lnd.conf-(optional))
23+
* [Simnet vs. Testnet Development](#simnet-vs-testnet-development)
24+
* [Creating an lnd.conf (Optional)](#creating-an-lndconf-optional)
2525

2626
# Installation
2727

@@ -32,71 +32,97 @@ title: Installation
3232
* **Go:** `lnd` is written in Go. To install, run one of the following commands:
3333

3434

35-
**Note**: The minimum version of Go supported is Go 1.11. We recommend to use 1.12.8 version of Go. The most recent v1.13 will be supported from lnd v0.8.0-beta.
35+
**Note**: The minimum version of Go supported is Go 1.13. We recommend that
36+
users use the latest version of Go, which at the time of writing is
37+
[`1.13`](https://blog.golang.org/go1.13).
3638

3739

3840
On Linux:
39-
```bash
40-
wget https://dl.google.com/go/go1.12.8.linux-amd64.tar.gz
41-
tar -C /usr/local -xzf go1.12.8.linux-amd64.tar.gz
41+
42+
(x86-64)
43+
```
44+
wget https://dl.google.com/go/go1.13.linux-amd64.tar.gz
45+
sha256sum go1.13.linux-amd64.tar.gz | awk -F " " '{ print $1 }'
46+
```
47+
48+
The final output of the command above should be
49+
`68a2297eb099d1a76097905a2ce334e3155004ec08cdea85f24527be3c48e856`. If it
50+
isn't, then the target REPO HAS BEEN MODIFIED, and you shouldn't install
51+
this version of Go. If it matches, then proceed to install Go:
52+
```
53+
tar -C /usr/local -xzf go1.13.linux-amd64.tar.gz
54+
export PATH=$PATH:/usr/local/go/bin
55+
```
56+
57+
(ARMv6)
58+
```
59+
wget https://dl.google.com/go/go1.13.linux-armv6l.tar.gz
60+
sha256sum go1.13.linux-armv6l.tar.gz | awk -F " " '{ print $1 }'
4261
```
62+
63+
The final output of the command above should be
64+
`931906d67cae1222f501e7be26e0ee73ba89420be0c4591925901cb9a4e156f0`. If it
65+
isn't, then the target REPO HAS BEEN MODIFIED, and you shouldn't install
66+
this version of Go. If it matches, then proceed to install Go:
67+
```
68+
tar -C /usr/local -xzf go1.13.linux-armv6l.tar.gz
69+
export PATH=$PATH:/usr/local/go/bin
70+
```
71+
4372
On Mac OS X:
44-
```bash
45-
brew install go
73+
```
74+
brew install go@1.13
4675
```
4776
4877
On FreeBSD:
49-
```bash
78+
```
5079
pkg install go
5180
```
5281
53-
The pre-compiled binaries are hosted on [golang download page](https://golang.org/dl/).
54-
In order to install from source, more detailed installation instructions can be found
55-
[here](http://golang.org/doc/install).
82+
Alternatively, one can download the pre-compiled binaries hosted on the
83+
[Golang download page](https://golang.org/dl/). If one seeks to install
84+
from source, then more detailed installation instructions can be found
85+
[here](https://golang.org/doc/install).
5686
57-
At this point, you should set your `PATH` environment variable so that your
58-
shell will be able to detect the binaries you install:
87+
At this point, you should set your `$GOPATH` environment variable, which
88+
represents the path to your workspace. By default, `$GOPATH` is set to
89+
`~/go`. You will also need to add `$GOPATH/bin` to your `PATH`. This ensures
90+
that your shell will be able to detect the binaries you install.
5991
60-
```bash
61-
export PATH=$PATH:/usr/local/go/bin
62-
```
63-
By default `GOPATH` is assumed to be `$HOME/go`. If you want to use a custom location as your
64-
workspace, you can set the GOPATH environment variable:
6592
```bash
6693
export GOPATH=~/gocode
6794
export PATH=$PATH:$GOPATH/bin
6895
```
6996
70-
It is recommended to place the above in your `/etc/profile` (for a system-wide installation),
71-
in `$HOME/.profile` or in a setup script so that you can avoid typing this every time you
72-
open a new terminal window.
97+
We recommend placing the above in your .bashrc or in a setup script so that
98+
you can avoid typing this every time you open a new terminal window.
7399
74-
* **go modules:** This project uses [go modules](https://github.com/golang/go/wiki/Modules)
100+
* **Go modules:** This project uses [Go modules](https://github.com/golang/go/wiki/Modules)
75101
to manage dependencies as well as to provide *reproducible builds*.
76102
77-
Usage of go modules means that you no longer need to clone
103+
Usage of Go modules (with Go 1.12) means that you no longer need to clone
78104
`lnd` into your `$GOPATH` for development purposes. Instead, your `lnd`
79105
repo can now live anywhere!
80106
81107
### Installing lnd
82108
83109
With the preliminary steps completed, to install `lnd`, `lncli`, and all
84110
related dependencies run the following commands:
85-
```bash
111+
```
86112
go get -d github.com/lightningnetwork/lnd
87113
cd $GOPATH/src/github.com/lightningnetwork/lnd
88114
make && make install
89115
```
90116
91117
**NOTE**: Our instructions still use the `$GOPATH` directory from prior
92-
versions of Go, but with go 1.11, it's now possible for `lnd` to live
118+
versions of Go, but with Go 1.12, it's now possible for `lnd` to live
93119
_anywhere_ on your file system.
94120
95121
For Windows WSL users, make will need to be referenced directly via
96122
/usr/bin/make/, or alternatively by wrapping quotation marks around make,
97123
like so:
98124
99-
```bash
125+
```
100126
/usr/bin/make && /usr/bin/make install
101127

102128
"make" && "make" install
@@ -106,15 +132,15 @@ On FreeBSD, use gmake instead of make.
106132
107133
Alternatively, if one doesn't wish to use `make`, then the `go` commands can be
108134
used directly:
109-
```bash
135+
```
110136
GO111MODULE=on go install -v ./...
111137
```
112138
113139
**Updating**
114140
115141
To update your version of `lnd` to the latest version run the following
116142
commands:
117-
```bash
143+
```
118144
cd $GOPATH/src/github.com/lightningnetwork/lnd
119145
git pull
120146
make clean && make && make install
@@ -124,7 +150,7 @@ On FreeBSD, use gmake instead of make.
124150
125151
Alternatively, if one doesn't wish to use `make`, then the `go` commands can be
126152
used directly:
127-
```bash
153+
```
128154
cd $GOPATH/src/github.com/lightningnetwork/lnd
129155
git pull
130156
GO111MODULE=on go install -v ./...
@@ -133,7 +159,7 @@ GO111MODULE=on go install -v ./...
133159
**Tests**
134160
135161
To check that `lnd` was installed properly run the following command:
136-
```bash
162+
```
137163
make check
138164
```
139165
@@ -248,7 +274,7 @@ btcctl --testnet --rpcuser=REPLACEME --rpcpass=REPLACEME getpeerinfo | more
248274
If you are on testnet, run this command after `btcd` has finished syncing.
249275
Otherwise, replace `--bitcoin.testnet` with `--bitcoin.simnet`. If you are
250276
installing `lnd` in preparation for the
251-
[tutorial](http://dev.lightning.community/tutorial), you may skip this step.
277+
[tutorial](https://dev.lightning.community/tutorial), you may skip this step.
252278
```
253279
lnd --bitcoin.active --bitcoin.testnet --debuglevel=debug --btcd.rpcuser=kek --btcd.rpcpass=kek --externalip=X.X.X.X
254280
```
@@ -257,8 +283,8 @@ lnd --bitcoin.active --bitcoin.testnet --debuglevel=debug --btcd.rpcuser=kek --b
257283
258284
In order to run `lnd` in its light client mode, you'll need to locate a
259285
full-node which is capable of serving this new light client mode. `lnd` uses
260-
[BIP 157](https://github.com/bitcoin/bips/tree/master/bip-0157) and [BIP
261-
158](https://github.com/bitcoin/bips/tree/master/bip-0158) for its light client
286+
[BIP 157](https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki) and [BIP
287+
158](https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki) for its light client
262288
mode. A public instance of such a node can be found at
263289
`faucet.lightning.community`.
264290
@@ -344,6 +370,20 @@ lnd --bitcoin.active --bitcoin.testnet --debuglevel=debug --bitcoin.node=bitcoin
344370
`lnd` plus any application that consumes the RPC could cause `lnd` to miss
345371
crucial updates from the backend.
346372
373+
374+
# Creating a wallet
375+
If `lnd` is being run for the first time, create a new wallet with:
376+
```
377+
lncli create
378+
```
379+
This will prompt for a wallet password, and optionally a cipher seed
380+
passphrase.
381+
382+
`lnd` will then print a 24 word cipher seed mnemonic, which can be used to
383+
recover the wallet in case of data loss. The user should write this down and
384+
keep in a safe place.
385+
386+
347387
# Macaroons
348388
349389
`lnd`'s authentication system is called **macaroons**, which are decentralized
@@ -421,3 +461,15 @@ for Litecoin accordingly. See a more detailed sample config file available
421461
and explore the other sections for node configuration, including `[Btcd]`,
422462
`[Bitcoind]`, `[Neutrino]`, `[Ltcd]`, and `[Litecoind]` depending on which
423463
chain and node type you're using.
464+
465+
466+
467+
468+
### Next Steps
469+
470+
* **[Tutorial](/tutorial/):** Get acquainted with the skills necessary for `lnd` development.
471+
* **[Developer Guides](/guides/):** Look through developer manuals on gRPC,
472+
Docker, and more.
473+
* **[Resources](/resources/):** Learn about the Lightning Network
474+
* **[Code Contribution Guidelines](/contribute/):** Contribute to `lnd` itself.
475+

0 commit comments

Comments
 (0)