Skip to content

Commit 79729c7

Browse files
authored
Update README (#1881)
1 parent 01b4073 commit 79729c7

File tree

1 file changed

+27
-17
lines changed

1 file changed

+27
-17
lines changed

README.md

+27-17
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,25 @@
77

88
**Eclair** (French for Lightning) is a Scala implementation of the Lightning Network.
99

10-
This software follows the [Lightning Network Specifications (BOLTs)](https://github.com/lightningnetwork/lightning-rfc). Other implementations include [c-lightning](https://github.com/ElementsProject/lightning) and [lnd](https://github.com/LightningNetwork/lnd).
10+
This software follows the [Lightning Network Specifications (BOLTs)](https://github.com/lightningnetwork/lightning-rfc). Other implementations include [c-lightning](https://github.com/ElementsProject/lightning), [lnd](https://github.com/LightningNetwork/lnd), [electrum](https://github.com/spesmilo/electrum/), and [rust-lightning](https://github.com/rust-bitcoin/rust-lightning).
1111

1212
---
13-
14-
:construction: Both the BOLTs and Eclair itself are still a work in progress. Expect things to break/change!
15-
16-
:rotating_light: If you run Eclair on mainnet (which is the default setting):
17-
18-
* Keep in mind that it is beta-quality software and **don't put too much money** in it
19-
* Eclair's JSON API should **NOT** be accessible from the outside world (similarly to Bitcoin Core API)
20-
13+
* [Lightning Network Specification Compliance](#lightning-network-specification-compliance)
14+
* [JSON API](#json-api)
15+
* [Documentation](#documentation)
16+
* [Installation](#installation)
17+
* [Prerequisite: Bitcoin Core](#prerequisite-bitcoin-core)
18+
* [Installing Eclair](#installing-eclair)
19+
* [Configuration](#configuration)
20+
* [Configuration file](#configuration-file)
21+
* [Configure Bitcoin Core wallet](#configure-bitcoin-core-wallet)
22+
* [Java Environment Variables](#java-environment-variables)
23+
* [Logging](#logging)
24+
* [Backup](#backup)
25+
* [Docker](#docker)
26+
* [Plugins](#plugins)
27+
* [Testnet usage](#testnet-usage)
28+
* [Resources](#resources)
2129
---
2230

2331
## Lightning Network Specification Compliance
@@ -30,6 +38,8 @@ Eclair offers a feature-rich HTTP API that enables application developers to eas
3038

3139
For more information please visit the [API documentation website](https://acinq.github.io/eclair).
3240

41+
:rotating_light: Eclair's JSON API should **NOT** be accessible from the outside world (similarly to Bitcoin Core API)
42+
3343
## Documentation
3444

3545
Please visit our [docs](./docs) and [wiki](https://github.com/acinq/eclair/wiki) to find detailed instructions on how to configure your
@@ -39,7 +49,7 @@ You will find detailed guides and frequently asked questions there.
3949

4050
## Installation
4151

42-
### Configuring Bitcoin Core
52+
### Prerequisite: Bitcoin Core
4353

4454
:warning: Eclair requires Bitcoin Core 0.20.1 or 0.21.1. If you are upgrading an existing wallet, you may need to create a new address and send all your funds to that address.
4555

@@ -73,9 +83,9 @@ eclair-node-<version>-<commit_id>/bin/eclair-node.sh
7383

7484
You can then control your node via the [eclair-cli](https://github.com/ACINQ/eclair/wiki/Usage) or the [API](https://github.com/ACINQ/eclair/wiki/API).
7585

76-
### Configuring Eclair
86+
## Configuration
7787

78-
#### Configuration file
88+
### Configuration file
7989

8090
Eclair reads its configuration file, and write its logs, to `~/.eclair` by default.
8191

@@ -105,7 +115,7 @@ Quotes are not required unless the value contains special characters. Full synta
105115

106116
&rarr; see [here](./docs/Configure.md) for more configuration options.
107117

108-
#### Configure Bitcoin Core wallet
118+
### Configure Bitcoin Core wallet
109119

110120
Eclair will use the default loaded Bitcoin Core wallet to fund any channels you choose to open.
111121
If you want to use a different wallet from the default one, you must set `eclair.bitcoind.wallet` accordingly in your `eclair.conf`.
@@ -115,7 +125,7 @@ If you want to use a different wallet from the default one, you must set `eclair
115125
Eclair will return BTC from closed channels to the wallet configured.
116126
Any BTC found in the wallet can be used to fund the channels you choose to open.
117127

118-
#### Java Environment Variables
128+
### Java Environment Variables
119129

120130
Some advanced parameters can be changed with java environment variables. Most users won't need this and can skip this section.
121131

@@ -132,15 +142,15 @@ For example, to specify a different data directory you would run the following c
132142
eclair-node-<version>-<commit_id>/bin/eclair-node.sh -Declair.datadir=/tmp/node1
133143
```
134144

135-
#### Logging
145+
### Logging
136146

137147
Eclair uses [`logback`](https://logback.qos.ch) for logging. To use a different configuration, and override the internal logback.xml, run:
138148

139149
```shell
140150
eclair-node-<version>-<commit_id>/bin/eclair-node.sh -Dlogback.configurationFile=/path/to/logback-custom.xml
141151
```
142152

143-
#### Backup
153+
### Backup
144154

145155
The files that you need to backup are located in your data directory. You must backup:
146156

@@ -154,7 +164,7 @@ always consistent and safe to use even when Eclair is running, and this is what
154164
For example, you could configure a `cron` task for your backup job. Or you could configure an optional notification script to be called by eclair once a new database snapshot has been created, using the following option:
155165

156166
```conf
157-
eclair.backup-notify-script = "/absolute/path/to/script.sh"
167+
eclair.file-backup.notify-script = "/absolute/path/to/script.sh"
158168
```
159169

160170
Make sure your script is executable and uses an absolute path name for `eclair.sqlite.bak`.

0 commit comments

Comments
 (0)