lndk/config_spec.toml

[general]
conf_file_param = "conf"

[[param]]
name = "address"
type = "String"
optional = false
doc = "LND GRPC address, kindly note that the address must start with https:// ip address : port."

[[param]]
name = "cert_path"
type = "std::path::PathBuf"
optional = true
doc = "The path to LND tls certificate file. Note: the abosolute tls certificate file path is required here."

[[param]]
name = "cert_pem"
type = "String"
optional = true
doc = "The PEM-encoded tls certificate to pass directly into LNDK."

[[param]]
name = "tls_ip"
type = "String"
optional = true
doc = "Add an ip or domain to the certificate used to access the LNDK server. To add multiple ip addresses, separate each ip address with a comma. Like: '192.168.0.1,lndkisdope.org'"

[[param]]
name = "macaroon_path"
type = "std::path::PathBuf"
optional = true
doc = "The path to LND macaroon file. Note: the abosolute macaroon file path is required here."

[[param]]
name = "macaroon_hex"
type = "String"
optional = true
doc = "The hex encoded macaroon to pass directly into LNDK"

[[param]]
name = "data_dir"
type = "String"
doc = "The path to the lndk data directory. By default this is stored in ~/.lndk/data"

[[param]]
name = "log_file"
type = "String"
doc = "The path to the lndk log file. If not specified, defaults to `<data_dir>/lndk.log`."

[[param]]
name = "log_level"
type = "String"
optional = true
doc = "The log verbosity level. This can be set to either 'error', 'warn', 'info', 'debug' or 'trace'."

[[param]]
name = "grpc_host"
type = "String"
optional = true
doc = "The host the grpc server will run on. Defaults to 127.0.0.1."

[[param]]
name = "grpc_port"
type = "u16"
optional = true
doc = "The port the grpc server will run on. Defaults to 7000."

[[param]]
name = "skip_version_check"
type = "bool"
default = "false"
doc = "Skip checking the LND version. Otherwise, LNDK checks that the LND version is compatible with LNDK."

[[param]]
name = "response_invoice_timeout"
type = "u32"
optional = true
doc = "Amount of time in seconds that server waits for an offer creator to respond with an invoice. Defaults to 15s."

[[param]]
name = "rate_limit_count"
type = "u8"
default = "10"
doc = "The number of calls each peer is allowed to make within the rate limit period. This value determines the maximum number of requests a peer can send before being rate limited."

[[param]]
name = "rate_limit_period_secs"
type = "u64"
default = "1"
doc = "The duration of the rate limit period in seconds. This value specifies the time window over which the rate limit count is applied."
use configure_me crate to manage argument parsing build.rs generates the configure_me structs. config_spec.toml specifies all command line arguments needed, their type and descriptions. Removed ArgsError enum, it's display trait, and parse_args subroutine since they are no longer needed. updates the documentation accordingly. 2023-04-06 16:06:18 +01:00			`[general]`
			`conf_file_param = "conf"`

			`[[param]]`
			`name = "address"`
			`type = "String"`
			`optional = false`
			`doc = "LND GRPC address, kindly note that the address must start with https:// ip address : port."`

			`[[param]]`
multi: add option to pass cert/macaroon in directly to lndk 2024-05-15 13:42:32 -05:00			`name = "cert_path"`
use configure_me crate to manage argument parsing build.rs generates the configure_me structs. config_spec.toml specifies all command line arguments needed, their type and descriptions. Removed ArgsError enum, it's display trait, and parse_args subroutine since they are no longer needed. updates the documentation accordingly. 2023-04-06 16:06:18 +01:00			`type = "std::path::PathBuf"`
multi: add option to pass cert/macaroon in directly to lndk 2024-05-15 13:42:32 -05:00			`optional = true`
use configure_me crate to manage argument parsing build.rs generates the configure_me structs. config_spec.toml specifies all command line arguments needed, their type and descriptions. Removed ArgsError enum, it's display trait, and parse_args subroutine since they are no longer needed. updates the documentation accordingly. 2023-04-06 16:06:18 +01:00			`doc = "The path to LND tls certificate file. Note: the abosolute tls certificate file path is required here."`

			`[[param]]`
cfg: pass in extra ips to tls certificate 2024-07-19 22:28:59 -05:00			`name = "cert_pem"`
			`type = "String"`
multi: add option to pass cert/macaroon in directly to lndk 2024-05-15 13:42:32 -05:00			`optional = true`
cfg: pass in extra ips to tls certificate 2024-07-19 22:28:59 -05:00			`doc = "The PEM-encoded tls certificate to pass directly into LNDK."`
main: replace simple logger with log4rs 2023-09-27 17:12:09 -05:00
multi: add option to pass cert/macaroon in directly to lndk 2024-05-15 13:42:32 -05:00			`[[param]]`
cfg: pass in extra ips to tls certificate 2024-07-19 22:28:59 -05:00			`name = "tls_ip"`
multi: add option to pass cert/macaroon in directly to lndk 2024-05-15 13:42:32 -05:00			`type = "String"`
			`optional = true`
cfg: pass in extra ips to tls certificate 2024-07-19 22:28:59 -05:00			`doc = "Add an ip or domain to the certificate used to access the LNDK server. To add multiple ip addresses, separate each ip address with a comma. Like: '192.168.0.1,lndkisdope.org'"`
multi: add option to pass cert/macaroon in directly to lndk 2024-05-15 13:42:32 -05:00
cfg: pass in extra ips to tls certificate 2024-07-19 22:28:59 -05:00			`[[param]]`
			`name = "macaroon_path"`
			`type = "std::path::PathBuf"`
			`optional = true`
			`doc = "The path to LND macaroon file. Note: the abosolute macaroon file path is required here."`
multi: add option to pass cert/macaroon in directly to lndk 2024-05-15 13:42:32 -05:00
			`[[param]]`
			`name = "macaroon_hex"`
			`type = "String"`
			`optional = true`
			`doc = "The hex encoded macaroon to pass directly into LNDK"`

Added data_dir configuration options. In certain deployment scenarios, we may not want (or be able) to write to the default ~/.lndk data directory. For example, the home directory may be mounted as read-only, or mounted using ephemeral storage. This change adds a new `data_dir` configuration option to specify where LNDK should store data. If this option isn't specified, then falls back to the default ~/.lndk. 2024-10-25 17:11:09 -07:00			`[[param]]`
			`name = "data_dir"`
			`type = "String"`
server: default lndk conf in lndk dir LNDK is already using a datadir to store TLS certificates. In this PR we default LNDK config and data to ~/.lndk. Datadir is moved inside the default dir ~/.lndk/data. Then, we expect lndk.conf file to be iether in root of the project, or the default LNDK config folder or --config flag. Precedence is flag > root > default dir. 2024-11-08 12:42:32 -03:00			`doc = "The path to the lndk data directory. By default this is stored in ~/.lndk/data"`
Added data_dir configuration options. In certain deployment scenarios, we may not want (or be able) to write to the default ~/.lndk data directory. For example, the home directory may be mounted as read-only, or mounted using ephemeral storage. This change adds a new `data_dir` configuration option to specify where LNDK should store data. If this option isn't specified, then falls back to the default ~/.lndk. 2024-10-25 17:11:09 -07:00
main: replace simple logger with log4rs 2023-09-27 17:12:09 -05:00			`[[param]]`
Renamed `log_dir` configuration to `log_file`. This is expected to be passed in as a file, not a directory, so change the name to reflect that fact. 2024-11-11 10:25:53 -08:00			`name = "log_file"`
main: replace simple logger with log4rs 2023-09-27 17:12:09 -05:00			`type = "String"`
Fall back to `data_dir` if `log_file` is unspecified. 2024-11-03 10:39:43 -08:00			doc = "The path to the lndk log file. If not specified, defaults to `<data_dir>/lndk.log`."
main: add config option for specifying log level 2024-03-14 23:55:41 -05:00
			`[[param]]`
			`name = "log_level"`
			`type = "String"`
			`optional = true`
			`doc = "The log verbosity level. This can be set to either 'error', 'warn', 'info', 'debug' or 'trace'."`
main: add grpc server config options Co-authored-by: Tom <tom@strike.me> 2024-05-06 06:31:34 -05:00
			`[[param]]`
			`name = "grpc_host"`
			`type = "String"`
			`optional = true`
			`doc = "The host the grpc server will run on. Defaults to 127.0.0.1."`

			`[[param]]`
			`name = "grpc_port"`
			`type = "u16"`
			`optional = true`
			`doc = "The port the grpc server will run on. Defaults to 7000."`
Add skip-version-check option. LNDK verifies that the version of LND running alongside it is compatible with LNDK. If users need to bypass this version check for any reason, they can use the skip-version-check option. 2024-07-16 09:57:08 +09:00
			`[[param]]`
			`name = "skip_version_check"`
			`type = "bool"`
			`default = "false"`
			`doc = "Skip checking the LND version. Otherwise, LNDK checks that the LND version is compatible with LNDK."`
multi: Configurable timeout for receiving invoice This commit introduces a parameter in the RPC to allow users to modify the timeout when receiving an invoice from the offer creator. Additionally, it adds a configuration parameter for the server to set up a default value if no parameter is used. The default timeout value is also decreased from 100 seconds to 20 seconds. 2024-06-18 00:00:39 -04:00
			`[[param]]`
			`name = "response_invoice_timeout"`
			`type = "u32"`
			`optional = true`
			`doc = "Amount of time in seconds that server waits for an offer creator to respond with an invoice. Defaults to 15s."`
Make rate limits configureable. Add 'rate_limit_count' and 'rate_limit_period' to configuration option. 2024-08-23 06:23:53 +09:00
			`[[param]]`
			`name = "rate_limit_count"`
			`type = "u8"`
			`default = "10"`
			`doc = "The number of calls each peer is allowed to make within the rate limit period. This value determines the maximum number of requests a peer can send before being rate limited."`

			`[[param]]`
			`name = "rate_limit_period_secs"`
			`type = "u64"`
			`default = "1"`
			`doc = "The duration of the rate limit period in seconds. This value specifies the time window over which the rate limit count is applied."`