lukechilds
/
lightning
mirror of https://github.com/lukechilds/lightning.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
8913 Commits
55 Branches
107 Tags
38 MiB
Tree: 9e4bed73d9
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '9e4bed73d9'
${ noResults }
lightning/doc/lightningd.8.md

188 lines
6.2 KiB
Raw Normal View History

docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the "last updated" lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I'd suggest generating them from the commit that last touched them.
5 years ago
lightningd -- Daemon for running a Lightning Network node
=========================================================
doc/manpages: replace asciidoc by markdown
5 years ago
SYNOPSIS
docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the "last updated" lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I'd suggest generating them from the commit that last touched them.
5 years ago
--------
```bash
lightningd [--conf=<config-file>] [OPTIONS]…
```
doc/manpages: replace asciidoc by markdown
5 years ago
DESCRIPTION
docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the &#34;last updated&#34; lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I&#39;d suggest generating them from the commit that last touched them.
5 years ago
-----------
doc/manpages: replace asciidoc by markdown
5 years ago
**lightningd** starts the C-Lightning daemon, which implements a
standards-compliant Lightning Network node.
CONFIGURATION OPTIONS
docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the &#34;last updated&#34; lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I&#39;d suggest generating them from the commit that last touched them.
5 years ago
---------------------
doc/manpages: replace asciidoc by markdown
5 years ago
**--conf**=*FILE*
Specify configuration file. If not an absolute path, will be relative
from the lightning-dir location. Defaults to *config*.
**--lightning-dir**=*DIR*
Set the directory for the C-Lightning daemon. Defaults to
*$HOME/.lightning*.
MORE OPTIONS
docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the &#34;last updated&#34; lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I&#39;d suggest generating them from the commit that last touched them.
5 years ago
------------
doc/manpages: replace asciidoc by markdown
5 years ago
Command line options are mirrored as configuration options in the
configuration file, so *foo* in the configuration file simply becomes
docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the &#34;last updated&#34; lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I&#39;d suggest generating them from the commit that last touched them.
5 years ago
**--foo** on the command line, and **foo=bar** becomes **--foo=bar**.
doc/manpages: replace asciidoc by markdown
5 years ago
See lightningd-config(5) for a comprehensive list of all available
options.
LOGGING AND COMMANDING C-LIGHTNING
docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the &#34;last updated&#34; lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I&#39;d suggest generating them from the commit that last touched them.
5 years ago
----------------------------------
doc/manpages: replace asciidoc by markdown
5 years ago
doc/lightningd.8.md: Fix formatting, remove old version. Changelog-none
5 years ago
By default, C-Lightning will log to the standard output.
To log to a specific file, use **--log-file**=*PATH*.
Sending SIGHUP will cause C-Lightning to reopen this file,
for example to do log rotation.
C-Lightning will set up a Unix domain socket for receiving
commands.
By default this will be the file **lightning-rpc** in your
specified **lightning-dir**.
You can use lightning-cli(1) to send commands to C-Lightning
once **lightningd** has started; you need to match the
**--lightning-dir** and **--rpc-file** options between them.
Commands for C-Lightning are described in various manpages
in section 7, with the common prefix **lightning-**.
QUICK START
-----------
doc/manpages: replace asciidoc by markdown
5 years ago
First, decide on and create a directory for *lightning-dir*, or just use
the default *$HOME/.lightning*. Then create a *config* file in this
directory containing your configuration.
Your other main preparation would be to set up a mainnet Bitcoin
fullnode, i.e. run a bitcoind(1) instance. The rest of this quick start
guide will assume you are reckless and want to spend real funds on
Lightning. Indicate *network=bitcoin* in your *config* file explicitly.
C-Lightning needs to communicate with the Bitcoin Core RPC. You can set
this up using *bitcoin-datadir*, *bitcoin-rpcconnect*,
*bitcoin-rpcport*, *bitcoin-rpcuser*, and *bitcoin-rpcpassword* options
in your *config* file.
Finally, just to keep yourself sane, decide on a log file name and
indicate it using *log-file=lightningd.log* in your *config* file. You
might be interested in viewing it periodically as you follow along on
this guide.
Once the **bitcoind** instance is running, start lightningd(8):
$ lightningd --lightning-dir=$HOME/.lightning --daemon
This starts **lightningd** in the background due to the *--daemon*
option.
Check if things are working:
$ lightning-cli --lightning-dir=%HOME/.lightning help
$ lightning-cli --lightning-dir=%HOME/.lightning getinfo
The **getinfo** command in particular will return a *blockheight* field,
which indicates the block height to which **lightningd** has been
synchronized to (this is separate from the block height that your
**bitcoind** has been synchronized to, and will always lag behind
**bitcoind**). You will have to wait until the *blockheight* has reached
the actual blockheight of the Bitcoin network.
Before you can get funds offchain, you need to have some funds onchain
owned by **lightningd** (which has a separate wallet from the
**bitcoind** it connects to). Get an address for **lightningd** via
lightning-newaddr(7) command as below (*--lightning-dir* option has been
elided, specify it if you selected your own *lightning-dir*):
$ lightning-cli newaddr
This will provide a native SegWit bech32 address. In case all your money
is in services that do not support native SegWit and have to use
P2SH-wrapped addresses, instead use:
$ lightning-cli newaddr p2sh-segwit
Transfer a small amount of onchain funds to the given address. Check the
status of all your funds (onchain and on-Lightning) via
lightning-listfunds(7):
$ lightning-cli listfunds
Now you need to look for an arbitrary Lightning node to connect to,
which you can do by using dig(1) and querying *lseed.bitcoinstats.com*:
$ dig lseed.bitcoinstats.com A
This will give 25 IPv4 addresses, you can select any one of those. You
will also need to learn the corresponding public key, which you can
determine by searching the IP addrss on <https://1ml.com/> . The public
key is a long hex string, like so:
*024772ee4fa461febcef09d5869e1238f932861f57be7a6633048514e3f56644a1*.
(this example public key is not used as of this writing)
After determining a public key, use lightning-connect(7) to connect to
doc/: Doc clarifications regarding connecting and funding. ChangeLog-Fixed: Clarified about connection in documentation. Also, `fundchannel` already `connect`s if your node knows how to contact the desired peer for a few versions now, so clarify documentation about this as well.
5 years ago
that public key at that IP:
doc/manpages: replace asciidoc by markdown
5 years ago
doc/: Doc clarifications regarding connecting and funding. ChangeLog-Fixed: Clarified about connection in documentation. Also, `fundchannel` already `connect`s if your node knows how to contact the desired peer for a few versions now, so clarify documentation about this as well.
5 years ago
$ lightning-cli connect $PUBLICKEY $IP
doc/manpages: replace asciidoc by markdown
5 years ago
Then open a channel to that node using lightning-fundchannel(7):
$ lightning-cli fundchannel $PUBLICKEY $SATOSHI
This will require that the funding transaction be confirmed before you
can send funds over Lightning. To track this, use lightning-listpeers(7)
and look at the *state* of the channel:
$ lightning-cli listpeers $PUBLICKEY
The channel will initially start with a *state* of
*CHANNELD\_AWAITING\_LOCKIN*. You need to wait for the channel *state*
to become *CHANNELD\_NORMAL*, meaning the funding transaction has been
confirmed deeply.
Once the channel *state* is *CHANNELD\_NORMAL*, you can start paying
merchants over Lightning. Acquire a Lightning invoice from your favorite
merchant, and use lightning-pay(7) to pay it:
$ lightning-cli pay $INVOICE
BUGS
docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the &#34;last updated&#34; lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I&#39;d suggest generating them from the commit that last touched them.
5 years ago
----
doc/manpages: replace asciidoc by markdown
5 years ago
You should report bugs on our github issues page, and maybe submit a fix
to gain our eternal gratitude!
AUTHOR
docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the &#34;last updated&#34; lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I&#39;d suggest generating them from the commit that last touched them.
5 years ago
------
doc/manpages: replace asciidoc by markdown
5 years ago
docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the &#34;last updated&#34; lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I&#39;d suggest generating them from the commit that last touched them.
5 years ago
ZmnSCPxj <<ZmnSCPxj@protonmail.com>> wrote the initial version of
doc/manpages: replace asciidoc by markdown
5 years ago
this man page, but many others did the hard work of actually
implementing a standards-compliant Lightning Network node
implementation.
SEE ALSO
docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the &#34;last updated&#34; lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I&#39;d suggest generating them from the commit that last touched them.
5 years ago
--------
doc/manpages: replace asciidoc by markdown
5 years ago
lightning-listconfigs(7), lightning-config(5), lightning-cli(1),
lightning-newaddr(7), lightning-listfunds(7), lightning-connect(7),
Makefile: Install `tools/hsmtool` as `lightning-hsmtool`. Changelog-Added: We now install `lightning-hsmtool` for your `hsm_secret` needs. See: https://github.com/ElementsProject/lightning/issues/3717#issuecomment-644844594 It seems reasonable to add this to the standard install, and to document it properly as well, hopefully we can fill in the documentation better later on.
5 years ago
lightning-fundchannel(7), lightning-listpeers(7), lightning-pay(7),
lightning-hsmtool(8)
doc/manpages: replace asciidoc by markdown
5 years ago
RESOURCES
docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the &#34;last updated&#34; lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I&#39;d suggest generating them from the commit that last touched them.
5 years ago
---------
doc/manpages: replace asciidoc by markdown
5 years ago
Main web site: <https://github.com/ElementsProject/lightning>
COPYING
docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the &#34;last updated&#34; lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I&#39;d suggest generating them from the commit that last touched them.
5 years ago
-------
doc/manpages: replace asciidoc by markdown
5 years ago
Note: the modules in the ccan/ directory have their own licenses, but
the rest of the code is covered by the BSD-style MIT license.
doc: force refresh of all manpages. The idea is that you regenerate the man pages in the same commit you alter them: that&#39;s how we know whether to try regenerating them or not (git doesn&#39;t store timestamps, so it can&#39;t really tell). Travis will now check this, so force them all to sync to this commit. Signed-off-by: Rusty Russell &lt;rusty@rustcorp.com.au&gt;
4 years ago