lightning-terminal/README.md

110 lines
6 KiB
Markdown
Raw Normal View History

# Lightning Terminal (LiT)
2020-04-06 15:36:33 -04:00
![CI](https://github.com/lightninglabs/lightning-terminal/workflows/CI/badge.svg)
2020-04-14 19:17:49 -04:00
Simplified readme (#129) Update README, simplify documentation Simplified to focus on the happy path * Connect to remote instance Instructions for connecting Terminal to a remote LND instance. * Add link to remote instance Link to new instructions for connecting Terminal to a remote LND instance. * Create build from source instructions Parse out the building from source instructions into a separate doc to simplify main README file. * Change configuration section Update configuration section to acknowledge ability to upgrade an LND instance to Terminal * Add upgrading section Ensure that there is a clear upgrade path for existing users that have modified their lnd.conf files to be compatible with Terminal * Reference integrated configuration doc Change configuration section to point to the integrate mode configuration doc. * Reference remote mode instructions In case the user needs further information point them to the more comprehensive instructions * Update configuration settings Change configuration settings to be more accurate and specific * Update compatibility Changed to v0.11.0-beta * Update README Add list of features and Daemon Versions table * Combine config links Put remote and integrated modes together but separate. * Create troubleshooting doc Specific information for troubleshooting * Add troubleshooting section Link out to the troubleshooting guide * Update configuration to interaction Make it more explicit as to what problem is being solved * Add quickstart section Quickstart section for those wanting to connect LiT with a standalone process on a remote host * Combine remote configs into one Reference the single remote config doc instead of chained docs. * Update doc/config-lnd-remote.md * Remove commands for downloading Sort of overkill in terms of info * Update README Add small changes to README to address comments * Update compile Address small nits * Update uipassword Make it clearer the password needs to be changed * Update with build tags Added build tags for LND since it is most likely the case that LND was built without tags.
2020-10-13 09:49:20 -10:00
Lightning Terminal (LiT) is a browser-based interface for managing channel liquidity.
Simplified readme (#129) Update README, simplify documentation Simplified to focus on the happy path * Connect to remote instance Instructions for connecting Terminal to a remote LND instance. * Add link to remote instance Link to new instructions for connecting Terminal to a remote LND instance. * Create build from source instructions Parse out the building from source instructions into a separate doc to simplify main README file. * Change configuration section Update configuration section to acknowledge ability to upgrade an LND instance to Terminal * Add upgrading section Ensure that there is a clear upgrade path for existing users that have modified their lnd.conf files to be compatible with Terminal * Reference integrated configuration doc Change configuration section to point to the integrate mode configuration doc. * Reference remote mode instructions In case the user needs further information point them to the more comprehensive instructions * Update configuration settings Change configuration settings to be more accurate and specific * Update compatibility Changed to v0.11.0-beta * Update README Add list of features and Daemon Versions table * Combine config links Put remote and integrated modes together but separate. * Create troubleshooting doc Specific information for troubleshooting * Add troubleshooting section Link out to the troubleshooting guide * Update configuration to interaction Make it more explicit as to what problem is being solved * Add quickstart section Quickstart section for those wanting to connect LiT with a standalone process on a remote host * Combine remote configs into one Reference the single remote config doc instead of chained docs. * Update doc/config-lnd-remote.md * Remove commands for downloading Sort of overkill in terms of info * Update README Add small changes to README to address comments * Update compile Address small nits * Update uipassword Make it clearer the password needs to be changed * Update with build tags Added build tags for LND since it is most likely the case that LND was built without tags.
2020-10-13 09:49:20 -10:00
![screenshot](./app/src/assets/images/screenshot.png)
2020-07-29 02:13:57 -04:00
Simplified readme (#129) Update README, simplify documentation Simplified to focus on the happy path * Connect to remote instance Instructions for connecting Terminal to a remote LND instance. * Add link to remote instance Link to new instructions for connecting Terminal to a remote LND instance. * Create build from source instructions Parse out the building from source instructions into a separate doc to simplify main README file. * Change configuration section Update configuration section to acknowledge ability to upgrade an LND instance to Terminal * Add upgrading section Ensure that there is a clear upgrade path for existing users that have modified their lnd.conf files to be compatible with Terminal * Reference integrated configuration doc Change configuration section to point to the integrate mode configuration doc. * Reference remote mode instructions In case the user needs further information point them to the more comprehensive instructions * Update configuration settings Change configuration settings to be more accurate and specific * Update compatibility Changed to v0.11.0-beta * Update README Add list of features and Daemon Versions table * Combine config links Put remote and integrated modes together but separate. * Create troubleshooting doc Specific information for troubleshooting * Add troubleshooting section Link out to the troubleshooting guide * Update configuration to interaction Make it more explicit as to what problem is being solved * Add quickstart section Quickstart section for those wanting to connect LiT with a standalone process on a remote host * Combine remote configs into one Reference the single remote config doc instead of chained docs. * Update doc/config-lnd-remote.md * Remove commands for downloading Sort of overkill in terms of info * Update README Add small changes to README to address comments * Update compile Address small nits * Update uipassword Make it clearer the password needs to be changed * Update with build tags Added build tags for LND since it is most likely the case that LND was built without tags.
2020-10-13 09:49:20 -10:00
## Features
- Visualize your channels and balances
- Perform submarine swaps via the [Lightning Loop](https://lightning.engineering/loop) service
- Classify channels according to your node's operating mode
2020-11-02 13:15:22 +01:00
- Run a single binary that integrates [`loopd`](https://github.com/lightninglabs/loop),
[`poold`](https://github.com/lightninglabs/pool) and
[`faraday`](https://github.com/lightninglabs/faraday) daemons all in one
2021-03-10 18:53:28 -10:00
- Access a preview release of the Pool UI
- Use Pool to earn sats by opening channels to those needing inbound liquidity
2020-07-29 02:13:57 -04:00
2020-06-03 22:23:25 -04:00
## Installation
Download the latest binaries from the [releases](https://github.com/lightninglabs/lightning-terminal/releases) page.
Additionally, you can find detailed instructions on the [docs.lightning.engineering](https://docs.lightning.engineering/lightning-network-tools/lightning-terminal/get-lit) page.
2020-06-03 22:23:25 -04:00
Simplified readme (#129) Update README, simplify documentation Simplified to focus on the happy path * Connect to remote instance Instructions for connecting Terminal to a remote LND instance. * Add link to remote instance Link to new instructions for connecting Terminal to a remote LND instance. * Create build from source instructions Parse out the building from source instructions into a separate doc to simplify main README file. * Change configuration section Update configuration section to acknowledge ability to upgrade an LND instance to Terminal * Add upgrading section Ensure that there is a clear upgrade path for existing users that have modified their lnd.conf files to be compatible with Terminal * Reference integrated configuration doc Change configuration section to point to the integrate mode configuration doc. * Reference remote mode instructions In case the user needs further information point them to the more comprehensive instructions * Update configuration settings Change configuration settings to be more accurate and specific * Update compatibility Changed to v0.11.0-beta * Update README Add list of features and Daemon Versions table * Combine config links Put remote and integrated modes together but separate. * Create troubleshooting doc Specific information for troubleshooting * Add troubleshooting section Link out to the troubleshooting guide * Update configuration to interaction Make it more explicit as to what problem is being solved * Add quickstart section Quickstart section for those wanting to connect LiT with a standalone process on a remote host * Combine remote configs into one Reference the single remote config doc instead of chained docs. * Update doc/config-lnd-remote.md * Remove commands for downloading Sort of overkill in terms of info * Update README Add small changes to README to address comments * Update compile Address small nits * Update uipassword Make it clearer the password needs to be changed * Update with build tags Added build tags for LND since it is most likely the case that LND was built without tags.
2020-10-13 09:49:20 -10:00
## Execution
Run Lightning Terminal with a local `lnd` instance:
2020-06-03 22:23:25 -04:00
```shell
⛰ ./litd --uipassword=UP48lm4Vjqxy<change_this_or_you_will_get_robbed>
2020-06-03 22:23:25 -04:00
```
Simplified readme (#129) Update README, simplify documentation Simplified to focus on the happy path * Connect to remote instance Instructions for connecting Terminal to a remote LND instance. * Add link to remote instance Link to new instructions for connecting Terminal to a remote LND instance. * Create build from source instructions Parse out the building from source instructions into a separate doc to simplify main README file. * Change configuration section Update configuration section to acknowledge ability to upgrade an LND instance to Terminal * Add upgrading section Ensure that there is a clear upgrade path for existing users that have modified their lnd.conf files to be compatible with Terminal * Reference integrated configuration doc Change configuration section to point to the integrate mode configuration doc. * Reference remote mode instructions In case the user needs further information point them to the more comprehensive instructions * Update configuration settings Change configuration settings to be more accurate and specific * Update compatibility Changed to v0.11.0-beta * Update README Add list of features and Daemon Versions table * Combine config links Put remote and integrated modes together but separate. * Create troubleshooting doc Specific information for troubleshooting * Add troubleshooting section Link out to the troubleshooting guide * Update configuration to interaction Make it more explicit as to what problem is being solved * Add quickstart section Quickstart section for those wanting to connect LiT with a standalone process on a remote host * Combine remote configs into one Reference the single remote config doc instead of chained docs. * Update doc/config-lnd-remote.md * Remove commands for downloading Sort of overkill in terms of info * Update README Add small changes to README to address comments * Update compile Address small nits * Update uipassword Make it clearer the password needs to be changed * Update with build tags Added build tags for LND since it is most likely the case that LND was built without tags.
2020-10-13 09:49:20 -10:00
Visit https://localhost:8443 to access Terminal.
2020-09-09 10:32:35 -04:00
Simplified readme (#129) Update README, simplify documentation Simplified to focus on the happy path * Connect to remote instance Instructions for connecting Terminal to a remote LND instance. * Add link to remote instance Link to new instructions for connecting Terminal to a remote LND instance. * Create build from source instructions Parse out the building from source instructions into a separate doc to simplify main README file. * Change configuration section Update configuration section to acknowledge ability to upgrade an LND instance to Terminal * Add upgrading section Ensure that there is a clear upgrade path for existing users that have modified their lnd.conf files to be compatible with Terminal * Reference integrated configuration doc Change configuration section to point to the integrate mode configuration doc. * Reference remote mode instructions In case the user needs further information point them to the more comprehensive instructions * Update configuration settings Change configuration settings to be more accurate and specific * Update compatibility Changed to v0.11.0-beta * Update README Add list of features and Daemon Versions table * Combine config links Put remote and integrated modes together but separate. * Create troubleshooting doc Specific information for troubleshooting * Add troubleshooting section Link out to the troubleshooting guide * Update configuration to interaction Make it more explicit as to what problem is being solved * Add quickstart section Quickstart section for those wanting to connect LiT with a standalone process on a remote host * Combine remote configs into one Reference the single remote config doc instead of chained docs. * Update doc/config-lnd-remote.md * Remove commands for downloading Sort of overkill in terms of info * Update README Add small changes to README to address comments * Update compile Address small nits * Update uipassword Make it clearer the password needs to be changed * Update with build tags Added build tags for LND since it is most likely the case that LND was built without tags.
2020-10-13 09:49:20 -10:00
Note that a password with a minimum of 8 characters is required to run Lightning Terminal. In a production environment, it's recommended that you store this password as an environment variable to avoid it being recorded in the command history.
2020-09-09 10:32:35 -04:00
Simplified readme (#129) Update README, simplify documentation Simplified to focus on the happy path * Connect to remote instance Instructions for connecting Terminal to a remote LND instance. * Add link to remote instance Link to new instructions for connecting Terminal to a remote LND instance. * Create build from source instructions Parse out the building from source instructions into a separate doc to simplify main README file. * Change configuration section Update configuration section to acknowledge ability to upgrade an LND instance to Terminal * Add upgrading section Ensure that there is a clear upgrade path for existing users that have modified their lnd.conf files to be compatible with Terminal * Reference integrated configuration doc Change configuration section to point to the integrate mode configuration doc. * Reference remote mode instructions In case the user needs further information point them to the more comprehensive instructions * Update configuration settings Change configuration settings to be more accurate and specific * Update compatibility Changed to v0.11.0-beta * Update README Add list of features and Daemon Versions table * Combine config links Put remote and integrated modes together but separate. * Create troubleshooting doc Specific information for troubleshooting * Add troubleshooting section Link out to the troubleshooting guide * Update configuration to interaction Make it more explicit as to what problem is being solved * Add quickstart section Quickstart section for those wanting to connect LiT with a standalone process on a remote host * Combine remote configs into one Reference the single remote config doc instead of chained docs. * Update doc/config-lnd-remote.md * Remove commands for downloading Sort of overkill in terms of info * Update README Add small changes to README to address comments * Update compile Address small nits * Update uipassword Make it clearer the password needs to be changed * Update with build tags Added build tags for LND since it is most likely the case that LND was built without tags.
2020-10-13 09:49:20 -10:00
To use LiT with a remote `lnd` instance please [follow these instructions](./doc/config-lnd-remote.md). If you would like to replace your existing LND instance with the one integrated within LiT please see [configuring Terminal](./doc/config-lnd-integrated.md).
2020-09-09 10:32:35 -04:00
Simplified readme (#129) Update README, simplify documentation Simplified to focus on the happy path * Connect to remote instance Instructions for connecting Terminal to a remote LND instance. * Add link to remote instance Link to new instructions for connecting Terminal to a remote LND instance. * Create build from source instructions Parse out the building from source instructions into a separate doc to simplify main README file. * Change configuration section Update configuration section to acknowledge ability to upgrade an LND instance to Terminal * Add upgrading section Ensure that there is a clear upgrade path for existing users that have modified their lnd.conf files to be compatible with Terminal * Reference integrated configuration doc Change configuration section to point to the integrate mode configuration doc. * Reference remote mode instructions In case the user needs further information point them to the more comprehensive instructions * Update configuration settings Change configuration settings to be more accurate and specific * Update compatibility Changed to v0.11.0-beta * Update README Add list of features and Daemon Versions table * Combine config links Put remote and integrated modes together but separate. * Create troubleshooting doc Specific information for troubleshooting * Add troubleshooting section Link out to the troubleshooting guide * Update configuration to interaction Make it more explicit as to what problem is being solved * Add quickstart section Quickstart section for those wanting to connect LiT with a standalone process on a remote host * Combine remote configs into one Reference the single remote config doc instead of chained docs. * Update doc/config-lnd-remote.md * Remove commands for downloading Sort of overkill in terms of info * Update README Add small changes to README to address comments * Update compile Address small nits * Update uipassword Make it clearer the password needs to be changed * Update with build tags Added build tags for LND since it is most likely the case that LND was built without tags.
2020-10-13 09:49:20 -10:00
## LND
Note that LiT requires `lnd` to be built with **all of its subservers** and requires running at least v0.11.0. Download the latest [official release binary](https://github.com/lightningnetwork/lnd/releases/latest) or build `lnd` from source by following the [installation instructions](https://github.com/lightningnetwork/lnd/blob/master/docs/INSTALL.md). If you choose to build `lnd` from source, use the following command to enable all the relevant subservers:
2020-09-09 10:32:35 -04:00
```shell
⛰ make install tags="signrpc walletrpc chainrpc invoicesrpc"
2020-09-09 10:32:35 -04:00
```
2020-06-03 22:23:25 -04:00
Simplified readme (#129) Update README, simplify documentation Simplified to focus on the happy path * Connect to remote instance Instructions for connecting Terminal to a remote LND instance. * Add link to remote instance Link to new instructions for connecting Terminal to a remote LND instance. * Create build from source instructions Parse out the building from source instructions into a separate doc to simplify main README file. * Change configuration section Update configuration section to acknowledge ability to upgrade an LND instance to Terminal * Add upgrading section Ensure that there is a clear upgrade path for existing users that have modified their lnd.conf files to be compatible with Terminal * Reference integrated configuration doc Change configuration section to point to the integrate mode configuration doc. * Reference remote mode instructions In case the user needs further information point them to the more comprehensive instructions * Update configuration settings Change configuration settings to be more accurate and specific * Update compatibility Changed to v0.11.0-beta * Update README Add list of features and Daemon Versions table * Combine config links Put remote and integrated modes together but separate. * Create troubleshooting doc Specific information for troubleshooting * Add troubleshooting section Link out to the troubleshooting guide * Update configuration to interaction Make it more explicit as to what problem is being solved * Add quickstart section Quickstart section for those wanting to connect LiT with a standalone process on a remote host * Combine remote configs into one Reference the single remote config doc instead of chained docs. * Update doc/config-lnd-remote.md * Remove commands for downloading Sort of overkill in terms of info * Update README Add small changes to README to address comments * Update compile Address small nits * Update uipassword Make it clearer the password needs to be changed * Update with build tags Added build tags for LND since it is most likely the case that LND was built without tags.
2020-10-13 09:49:20 -10:00
## Interaction
If you plan to run LiT on a remote machine but access the web-interface from your computer you may not want to deal with self-signed certificate browser warnings. To avoid these warnings configure the HTTP server to use a certificate from [Let's Encrypt](https://letsencrypt.org/). View the
[Let's Encrypt Configuration](./doc/letsencrypt.md) doc for instructions on how to configure this.
2020-06-13 00:39:59 -04:00
Simplified readme (#129) Update README, simplify documentation Simplified to focus on the happy path * Connect to remote instance Instructions for connecting Terminal to a remote LND instance. * Add link to remote instance Link to new instructions for connecting Terminal to a remote LND instance. * Create build from source instructions Parse out the building from source instructions into a separate doc to simplify main README file. * Change configuration section Update configuration section to acknowledge ability to upgrade an LND instance to Terminal * Add upgrading section Ensure that there is a clear upgrade path for existing users that have modified their lnd.conf files to be compatible with Terminal * Reference integrated configuration doc Change configuration section to point to the integrate mode configuration doc. * Reference remote mode instructions In case the user needs further information point them to the more comprehensive instructions * Update configuration settings Change configuration settings to be more accurate and specific * Update compatibility Changed to v0.11.0-beta * Update README Add list of features and Daemon Versions table * Combine config links Put remote and integrated modes together but separate. * Create troubleshooting doc Specific information for troubleshooting * Add troubleshooting section Link out to the troubleshooting guide * Update configuration to interaction Make it more explicit as to what problem is being solved * Add quickstart section Quickstart section for those wanting to connect LiT with a standalone process on a remote host * Combine remote configs into one Reference the single remote config doc instead of chained docs. * Update doc/config-lnd-remote.md * Remove commands for downloading Sort of overkill in terms of info * Update README Add small changes to README to address comments * Update compile Address small nits * Update uipassword Make it clearer the password needs to be changed * Update with build tags Added build tags for LND since it is most likely the case that LND was built without tags.
2020-10-13 09:49:20 -10:00
## Upgrading
If you used command line arguments with previous versions then you don't need to change anything when upgrading.
2020-06-13 00:39:59 -04:00
Simplified readme (#129) Update README, simplify documentation Simplified to focus on the happy path * Connect to remote instance Instructions for connecting Terminal to a remote LND instance. * Add link to remote instance Link to new instructions for connecting Terminal to a remote LND instance. * Create build from source instructions Parse out the building from source instructions into a separate doc to simplify main README file. * Change configuration section Update configuration section to acknowledge ability to upgrade an LND instance to Terminal * Add upgrading section Ensure that there is a clear upgrade path for existing users that have modified their lnd.conf files to be compatible with Terminal * Reference integrated configuration doc Change configuration section to point to the integrate mode configuration doc. * Reference remote mode instructions In case the user needs further information point them to the more comprehensive instructions * Update configuration settings Change configuration settings to be more accurate and specific * Update compatibility Changed to v0.11.0-beta * Update README Add list of features and Daemon Versions table * Combine config links Put remote and integrated modes together but separate. * Create troubleshooting doc Specific information for troubleshooting * Add troubleshooting section Link out to the troubleshooting guide * Update configuration to interaction Make it more explicit as to what problem is being solved * Add quickstart section Quickstart section for those wanting to connect LiT with a standalone process on a remote host * Combine remote configs into one Reference the single remote config doc instead of chained docs. * Update doc/config-lnd-remote.md * Remove commands for downloading Sort of overkill in terms of info * Update README Add small changes to README to address comments * Update compile Address small nits * Update uipassword Make it clearer the password needs to be changed * Update with build tags Added build tags for LND since it is most likely the case that LND was built without tags.
2020-10-13 09:49:20 -10:00
To upgrade from v0.1.1-alpha or earlier simply create a `lit.conf` file in your LiT directory. The default location LiT uses depends on your operating system:
- MacOS: `~/Library/Application Support/Lit/lit.conf`
- Linux: `~/.lit/lit.conf`
- Windows: `~/AppData/Roaming/Lit/lit.conf`
2020-06-03 22:23:25 -04:00
Simplified readme (#129) Update README, simplify documentation Simplified to focus on the happy path * Connect to remote instance Instructions for connecting Terminal to a remote LND instance. * Add link to remote instance Link to new instructions for connecting Terminal to a remote LND instance. * Create build from source instructions Parse out the building from source instructions into a separate doc to simplify main README file. * Change configuration section Update configuration section to acknowledge ability to upgrade an LND instance to Terminal * Add upgrading section Ensure that there is a clear upgrade path for existing users that have modified their lnd.conf files to be compatible with Terminal * Reference integrated configuration doc Change configuration section to point to the integrate mode configuration doc. * Reference remote mode instructions In case the user needs further information point them to the more comprehensive instructions * Update configuration settings Change configuration settings to be more accurate and specific * Update compatibility Changed to v0.11.0-beta * Update README Add list of features and Daemon Versions table * Combine config links Put remote and integrated modes together but separate. * Create troubleshooting doc Specific information for troubleshooting * Add troubleshooting section Link out to the troubleshooting guide * Update configuration to interaction Make it more explicit as to what problem is being solved * Add quickstart section Quickstart section for those wanting to connect LiT with a standalone process on a remote host * Combine remote configs into one Reference the single remote config doc instead of chained docs. * Update doc/config-lnd-remote.md * Remove commands for downloading Sort of overkill in terms of info * Update README Add small changes to README to address comments * Update compile Address small nits * Update uipassword Make it clearer the password needs to be changed * Update with build tags Added build tags for LND since it is most likely the case that LND was built without tags.
2020-10-13 09:49:20 -10:00
Move all the configuration settings specific to LiT from `lnd.conf` to `lit.conf` and remove any previous LiT-specific customizations from the configuration settings in `lnd.conf`. Note that any section headers (`[ Example ]`) in `lit.conf` should be removed or changed to comments (`# Example`).
2020-06-03 22:23:25 -04:00
Simplified readme (#129) Update README, simplify documentation Simplified to focus on the happy path * Connect to remote instance Instructions for connecting Terminal to a remote LND instance. * Add link to remote instance Link to new instructions for connecting Terminal to a remote LND instance. * Create build from source instructions Parse out the building from source instructions into a separate doc to simplify main README file. * Change configuration section Update configuration section to acknowledge ability to upgrade an LND instance to Terminal * Add upgrading section Ensure that there is a clear upgrade path for existing users that have modified their lnd.conf files to be compatible with Terminal * Reference integrated configuration doc Change configuration section to point to the integrate mode configuration doc. * Reference remote mode instructions In case the user needs further information point them to the more comprehensive instructions * Update configuration settings Change configuration settings to be more accurate and specific * Update compatibility Changed to v0.11.0-beta * Update README Add list of features and Daemon Versions table * Combine config links Put remote and integrated modes together but separate. * Create troubleshooting doc Specific information for troubleshooting * Add troubleshooting section Link out to the troubleshooting guide * Update configuration to interaction Make it more explicit as to what problem is being solved * Add quickstart section Quickstart section for those wanting to connect LiT with a standalone process on a remote host * Combine remote configs into one Reference the single remote config doc instead of chained docs. * Update doc/config-lnd-remote.md * Remove commands for downloading Sort of overkill in terms of info * Update README Add small changes to README to address comments * Update compile Address small nits * Update uipassword Make it clearer the password needs to be changed * Update with build tags Added build tags for LND since it is most likely the case that LND was built without tags.
2020-10-13 09:49:20 -10:00
## Usage
Read the [walkthrough](doc/WALKTHROUGH.md) document to learn more about how to use LiT.
2020-06-03 22:23:25 -04:00
Simplified readme (#129) Update README, simplify documentation Simplified to focus on the happy path * Connect to remote instance Instructions for connecting Terminal to a remote LND instance. * Add link to remote instance Link to new instructions for connecting Terminal to a remote LND instance. * Create build from source instructions Parse out the building from source instructions into a separate doc to simplify main README file. * Change configuration section Update configuration section to acknowledge ability to upgrade an LND instance to Terminal * Add upgrading section Ensure that there is a clear upgrade path for existing users that have modified their lnd.conf files to be compatible with Terminal * Reference integrated configuration doc Change configuration section to point to the integrate mode configuration doc. * Reference remote mode instructions In case the user needs further information point them to the more comprehensive instructions * Update configuration settings Change configuration settings to be more accurate and specific * Update compatibility Changed to v0.11.0-beta * Update README Add list of features and Daemon Versions table * Combine config links Put remote and integrated modes together but separate. * Create troubleshooting doc Specific information for troubleshooting * Add troubleshooting section Link out to the troubleshooting guide * Update configuration to interaction Make it more explicit as to what problem is being solved * Add quickstart section Quickstart section for those wanting to connect LiT with a standalone process on a remote host * Combine remote configs into one Reference the single remote config doc instead of chained docs. * Update doc/config-lnd-remote.md * Remove commands for downloading Sort of overkill in terms of info * Update README Add small changes to README to address comments * Update compile Address small nits * Update uipassword Make it clearer the password needs to be changed * Update with build tags Added build tags for LND since it is most likely the case that LND was built without tags.
2020-10-13 09:49:20 -10:00
## Troubleshooting
If you encounter any issues please see our [troubleshooting guide](./doc/troubleshooting.md).
2020-06-03 22:23:25 -04:00
Simplified readme (#129) Update README, simplify documentation Simplified to focus on the happy path * Connect to remote instance Instructions for connecting Terminal to a remote LND instance. * Add link to remote instance Link to new instructions for connecting Terminal to a remote LND instance. * Create build from source instructions Parse out the building from source instructions into a separate doc to simplify main README file. * Change configuration section Update configuration section to acknowledge ability to upgrade an LND instance to Terminal * Add upgrading section Ensure that there is a clear upgrade path for existing users that have modified their lnd.conf files to be compatible with Terminal * Reference integrated configuration doc Change configuration section to point to the integrate mode configuration doc. * Reference remote mode instructions In case the user needs further information point them to the more comprehensive instructions * Update configuration settings Change configuration settings to be more accurate and specific * Update compatibility Changed to v0.11.0-beta * Update README Add list of features and Daemon Versions table * Combine config links Put remote and integrated modes together but separate. * Create troubleshooting doc Specific information for troubleshooting * Add troubleshooting section Link out to the troubleshooting guide * Update configuration to interaction Make it more explicit as to what problem is being solved * Add quickstart section Quickstart section for those wanting to connect LiT with a standalone process on a remote host * Combine remote configs into one Reference the single remote config doc instead of chained docs. * Update doc/config-lnd-remote.md * Remove commands for downloading Sort of overkill in terms of info * Update README Add small changes to README to address comments * Update compile Address small nits * Update uipassword Make it clearer the password needs to be changed * Update with build tags Added build tags for LND since it is most likely the case that LND was built without tags.
2020-10-13 09:49:20 -10:00
## Build from source
If youd prefer to compile from source code please follow [these instructions](./doc/compile.md).
2020-06-03 22:23:25 -04:00
Simplified readme (#129) Update README, simplify documentation Simplified to focus on the happy path * Connect to remote instance Instructions for connecting Terminal to a remote LND instance. * Add link to remote instance Link to new instructions for connecting Terminal to a remote LND instance. * Create build from source instructions Parse out the building from source instructions into a separate doc to simplify main README file. * Change configuration section Update configuration section to acknowledge ability to upgrade an LND instance to Terminal * Add upgrading section Ensure that there is a clear upgrade path for existing users that have modified their lnd.conf files to be compatible with Terminal * Reference integrated configuration doc Change configuration section to point to the integrate mode configuration doc. * Reference remote mode instructions In case the user needs further information point them to the more comprehensive instructions * Update configuration settings Change configuration settings to be more accurate and specific * Update compatibility Changed to v0.11.0-beta * Update README Add list of features and Daemon Versions table * Combine config links Put remote and integrated modes together but separate. * Create troubleshooting doc Specific information for troubleshooting * Add troubleshooting section Link out to the troubleshooting guide * Update configuration to interaction Make it more explicit as to what problem is being solved * Add quickstart section Quickstart section for those wanting to connect LiT with a standalone process on a remote host * Combine remote configs into one Reference the single remote config doc instead of chained docs. * Update doc/config-lnd-remote.md * Remove commands for downloading Sort of overkill in terms of info * Update README Add small changes to README to address comments * Update compile Address small nits * Update uipassword Make it clearer the password needs to be changed * Update with build tags Added build tags for LND since it is most likely the case that LND was built without tags.
2020-10-13 09:49:20 -10:00
## Compatibility
Lightning Terminal is backwards compatible with `lnd` back to version v0.13.3-beta.
Simplified readme (#129) Update README, simplify documentation Simplified to focus on the happy path * Connect to remote instance Instructions for connecting Terminal to a remote LND instance. * Add link to remote instance Link to new instructions for connecting Terminal to a remote LND instance. * Create build from source instructions Parse out the building from source instructions into a separate doc to simplify main README file. * Change configuration section Update configuration section to acknowledge ability to upgrade an LND instance to Terminal * Add upgrading section Ensure that there is a clear upgrade path for existing users that have modified their lnd.conf files to be compatible with Terminal * Reference integrated configuration doc Change configuration section to point to the integrate mode configuration doc. * Reference remote mode instructions In case the user needs further information point them to the more comprehensive instructions * Update configuration settings Change configuration settings to be more accurate and specific * Update compatibility Changed to v0.11.0-beta * Update README Add list of features and Daemon Versions table * Combine config links Put remote and integrated modes together but separate. * Create troubleshooting doc Specific information for troubleshooting * Add troubleshooting section Link out to the troubleshooting guide * Update configuration to interaction Make it more explicit as to what problem is being solved * Add quickstart section Quickstart section for those wanting to connect LiT with a standalone process on a remote host * Combine remote configs into one Reference the single remote config doc instead of chained docs. * Update doc/config-lnd-remote.md * Remove commands for downloading Sort of overkill in terms of info * Update README Add small changes to README to address comments * Update compile Address small nits * Update uipassword Make it clearer the password needs to be changed * Update with build tags Added build tags for LND since it is most likely the case that LND was built without tags.
2020-10-13 09:49:20 -10:00
| LiT | LND |
2021-12-03 22:59:56 +01:00
|------------------| ------------ |
| **v0.6.3-alpha** | v0.13.3-beta |
| **v0.6.2-alpha** | v0.13.3-beta |
2021-12-03 22:59:56 +01:00
| **v0.6.1-alpha** | v0.13.3-beta |
| **v0.6.0-alpha** | v0.13.3-beta |
| **v0.5.2-alpha** | v0.12.0-beta |
| **v0.5.1-alpha** | v0.12.0-beta |
| **v0.5.0-alpha** | v0.12.0-beta |
| **v0.4.1-alpha** | v0.11.1-beta |
2021-01-28 09:32:29 +01:00
| **v0.4.0-alpha** | v0.11.1-beta |
2020-12-21 23:57:26 +01:00
| **v0.3.4-alpha** | v0.11.1-beta |
| **v0.3.3-alpha** | v0.11.1-beta |
2020-12-08 00:06:14 +01:00
| **v0.3.2-alpha** | v0.11.1-beta |
2020-11-16 21:22:52 +01:00
| **v0.3.1-alpha** | v0.11.1-beta |
2020-10-30 09:32:35 +01:00
| **v0.3.0-alpha** | v0.11.1-beta |
Simplified readme (#129) Update README, simplify documentation Simplified to focus on the happy path * Connect to remote instance Instructions for connecting Terminal to a remote LND instance. * Add link to remote instance Link to new instructions for connecting Terminal to a remote LND instance. * Create build from source instructions Parse out the building from source instructions into a separate doc to simplify main README file. * Change configuration section Update configuration section to acknowledge ability to upgrade an LND instance to Terminal * Add upgrading section Ensure that there is a clear upgrade path for existing users that have modified their lnd.conf files to be compatible with Terminal * Reference integrated configuration doc Change configuration section to point to the integrate mode configuration doc. * Reference remote mode instructions In case the user needs further information point them to the more comprehensive instructions * Update configuration settings Change configuration settings to be more accurate and specific * Update compatibility Changed to v0.11.0-beta * Update README Add list of features and Daemon Versions table * Combine config links Put remote and integrated modes together but separate. * Create troubleshooting doc Specific information for troubleshooting * Add troubleshooting section Link out to the troubleshooting guide * Update configuration to interaction Make it more explicit as to what problem is being solved * Add quickstart section Quickstart section for those wanting to connect LiT with a standalone process on a remote host * Combine remote configs into one Reference the single remote config doc instead of chained docs. * Update doc/config-lnd-remote.md * Remove commands for downloading Sort of overkill in terms of info * Update README Add small changes to README to address comments * Update compile Address small nits * Update uipassword Make it clearer the password needs to be changed * Update with build tags Added build tags for LND since it is most likely the case that LND was built without tags.
2020-10-13 09:49:20 -10:00
| **v0.2.0-alpha** | v0.11.0-beta |
Simplified readme (#129) Update README, simplify documentation Simplified to focus on the happy path * Connect to remote instance Instructions for connecting Terminal to a remote LND instance. * Add link to remote instance Link to new instructions for connecting Terminal to a remote LND instance. * Create build from source instructions Parse out the building from source instructions into a separate doc to simplify main README file. * Change configuration section Update configuration section to acknowledge ability to upgrade an LND instance to Terminal * Add upgrading section Ensure that there is a clear upgrade path for existing users that have modified their lnd.conf files to be compatible with Terminal * Reference integrated configuration doc Change configuration section to point to the integrate mode configuration doc. * Reference remote mode instructions In case the user needs further information point them to the more comprehensive instructions * Update configuration settings Change configuration settings to be more accurate and specific * Update compatibility Changed to v0.11.0-beta * Update README Add list of features and Daemon Versions table * Combine config links Put remote and integrated modes together but separate. * Create troubleshooting doc Specific information for troubleshooting * Add troubleshooting section Link out to the troubleshooting guide * Update configuration to interaction Make it more explicit as to what problem is being solved * Add quickstart section Quickstart section for those wanting to connect LiT with a standalone process on a remote host * Combine remote configs into one Reference the single remote config doc instead of chained docs. * Update doc/config-lnd-remote.md * Remove commands for downloading Sort of overkill in terms of info * Update README Add small changes to README to address comments * Update compile Address small nits * Update uipassword Make it clearer the password needs to be changed * Update with build tags Added build tags for LND since it is most likely the case that LND was built without tags.
2020-10-13 09:49:20 -10:00
## Daemon Versions packaged with LiT
| LiT | LND | Loop | Faraday | Pool |
|------------------|--------------| ----------- | ------------ |--------------|
| **v0.6.3-alpha** | v0.14.2-beta | v0.15.1-beta | v0.2.7-alpha | v0.5.4-alpha |
| **v0.6.2-alpha** | v0.14.1-beta | v0.15.1-beta | v0.2.7-alpha | v0.5.4-alpha |
2021-12-03 22:59:56 +01:00
| **v0.6.1-alpha** | v0.14.1-beta | v0.15.1-beta | v0.2.7-alpha | v0.5.2-alpha |
2021-11-02 14:17:00 +01:00
| **v0.5.3-alpha** | v0.13.3-beta | v0.14.1-beta | v0.2.6-alpha | v0.5.0-alpha |
| **v0.5.2-alpha** | v0.13.3-beta | v0.14.1-beta | v0.2.6-alpha | v0.5.0-alpha |
| **v0.5.1-alpha** | v0.13.0-beta | v0.14.1-beta | v0.2.6-alpha | v0.5.0-alpha |
| **v0.5.0-alpha** | v0.13.0-beta | v0.14.1-beta | v0.2.6-alpha | v0.5.0-alpha |
| **v0.4.1-alpha** | v0.12.1-beta | v0.11.4-beta | v0.2.3-alpha | v0.4.4-alpha |
2021-01-28 09:32:29 +01:00
| **v0.4.0-alpha** | v0.12.0-beta | v0.11.2-beta | v0.2.3-alpha | v0.4.3-alpha |
2020-12-21 23:57:26 +01:00
| **v0.3.4-alpha** | v0.11.1-beta | v0.11.2-beta | v0.2.2-alpha | v0.3.4-alpha |
| **v0.3.3-alpha** | v0.11.1-beta | v0.11.2-beta | v0.2.2-alpha | v0.3.4-alpha |
2020-12-08 00:06:14 +01:00
| **v0.3.2-alpha** | v0.11.1-beta | v0.11.1-beta | v0.2.2-alpha | v0.3.4-alpha |
2020-11-16 21:22:52 +01:00
| **v0.3.1-alpha** | v0.11.1-beta | v0.11.1-beta | v0.2.2-alpha | v0.3.3-alpha |
2020-10-30 09:32:35 +01:00
| **v0.3.0-alpha** | v0.11.1-beta | v0.11.0-beta | v0.2.2-alpha | v0.3.2-alpha |
| **v0.2.0-alpha** | v0.11.1-beta | v0.10.0-beta | v0.2.1-alpha | n/a |
| **v0.1.1-alpha** | v0.11.0-beta | v0.8.1-beta | v0.2.0-alpha | n/a |
| **v0.1.0-alpha** | v0.10.3-beta | v0.6.5-beta | v0.2.0-alpha | n/a |