Add some documentation for the configuration environment variables #61
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JssDWt
reviewed
Feb 10, 2023
sample.env
Outdated
| @@ -20,3 +30,16 @@ CHANNELMISMATCH_NOTIFICATION_FROM="Name4 <user4@domain.com>" | |||
| USE_MEMPOOL_FEE_ESTIMATION=true | |||
| MEMPOOL_API_BASE_URL=https://mempool.space/api/v1/ | |||
| NODES='[ { "name": "<LSP NAME>", "nodePubkey": "<LIGHTNING NODE PUBKEY>", "lspdPrivateKey": "<LSPD PRIVATE KEY>", "token": "<ACCESS TOKEN>", "host": "<HOSTNAME:PORT for lightning clients>", "publicChannelAmount": "1000183", "channelAmount": "100000", "channelPrivate": false, "targetConf": "6", "minHtlcMsat": "600", "baseFeeMsat": "1000", "feeRate": "0.000001", "timeLockDelta": "144", "channelFeePermyriad": "40", "channelMinimumFeeMsat": "2000000", "additionalChannelCapacity": "100000", "maxInactiveDuration": "3888000", "lnd": { "address": "<HOSTNAME:PORT>", "cert": "<LND_CERT base64>", "macaroon": "<LND_MACAROON hex>" } }, { "name": "<LSP NAME>", "nodePubkey": "<LIGHTNING NODE PUBKEY>", "lspdPrivateKey": "<LSPD PRIVATE KEY>", "token": "<ACCESS TOKEN>", "host": "<HOSTNAME:PORT for lightning clients>", "publicChannelAmount": "1000183", "channelAmount": "100000", "channelPrivate": false, "targetConf": "6", "minHtlcMsat": "600", "baseFeeMsat": "1000", "feeRate": "0.000001", "timeLockDelta": "144", "channelFeePermyriad": "40", "channelMinimumFeeMsat": "2000000", "additionalChannelCapacity": "100000", "maxInactiveDuration": "3888000", "cln": { "pluginAddress": "<address the lsp cln plugin listens on (ip:port)>", "socketPath": "<path to the cln lightning-rpc socket file>" } } ]' | |||
| # If lnd is not used, the "lnd" key can be omitted. The same for applies to cln. | |||
There was a problem hiding this comment.
suggestion:
lspd can operate on multiple nodes. Multiple lsp's basically. In this example configuration 2 nodes are configured. One cln node and one lnd node. Every node should have either an lnd field or a cln field.
| # public key corresponding to this private key and the client encrypt all the | ||
| # messages sent to the LSP using this public key. | ||
| # The goal is to hide anything from breez-server which is the pass "opaque" data | ||
| # from the app to lspd. |
There was a problem hiding this comment.
Maybe for the node configuration values we can add documentation comments in config.go and refer to that here.
JssDWt
force-pushed
the
config-documentaion
branch
from
0b54015
to
61bee15
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.