You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-17
Original file line number
Diff line number
Diff line change
@@ -7,17 +7,25 @@
7
7
8
8
**Eclair** (French for Lightning) is a Scala implementation of the Lightning Network.
9
9
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).
11
11
12
12
---
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)
@@ -30,6 +38,8 @@ Eclair offers a feature-rich HTTP API that enables application developers to eas
30
38
31
39
For more information please visit the [API documentation website](https://acinq.github.io/eclair).
32
40
41
+
:rotating_light: Eclair's JSON API should **NOT** be accessible from the outside world (similarly to Bitcoin Core API)
42
+
33
43
## Documentation
34
44
35
45
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.
39
49
40
50
## Installation
41
51
42
-
### Configuring Bitcoin Core
52
+
### Prerequisite: Bitcoin Core
43
53
44
54
: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.
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).
75
85
76
-
### Configuring Eclair
86
+
##Configuration
77
87
78
-
####Configuration file
88
+
### Configuration file
79
89
80
90
Eclair reads its configuration file, and write its logs, to `~/.eclair` by default.
81
91
@@ -105,7 +115,7 @@ Quotes are not required unless the value contains special characters. Full synta
105
115
106
116
→ see [here](./docs/Configure.md) for more configuration options.
107
117
108
-
####Configure Bitcoin Core wallet
118
+
### Configure Bitcoin Core wallet
109
119
110
120
Eclair will use the default loaded Bitcoin Core wallet to fund any channels you choose to open.
111
121
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
115
125
Eclair will return BTC from closed channels to the wallet configured.
116
126
Any BTC found in the wallet can be used to fund the channels you choose to open.
117
127
118
-
####Java Environment Variables
128
+
### Java Environment Variables
119
129
120
130
Some advanced parameters can be changed with java environment variables. Most users won't need this and can skip this section.
121
131
@@ -132,15 +142,15 @@ For example, to specify a different data directory you would run the following c
The files that you need to backup are located in your data directory. You must backup:
146
156
@@ -154,7 +164,7 @@ always consistent and safe to use even when Eclair is running, and this is what
154
164
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:
0 commit comments