docs: add sample-litd.conf and reference it in README#1325
docs: add sample-litd.conf and reference it in README#1325victorabarros wants to merge 7 commits into
Conversation
This commit introduces a new sample configuration file, `sample-litd.conf`, which provides a comprehensive template for configuring litd. It includes detailed comments on various options, including application settings, daemon modes, TLS configuration, and Let's Encrypt integration. This file serves as a reference for users to set up their litd instances effectively.
…ptions This commit adds a note in the README.md file directing users to the `sample-litd.conf` for a complete reference of all litd-native configuration options, including descriptions and defaults.
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request improves the developer and user experience by providing a centralized, well-documented configuration template for litd. By creating a dedicated sample file, it eliminates the need for users to manually search through help output or source code to identify available configuration settings and their default values. Highlights
New Features🧠 You can now enable Memory (public preview) to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a comprehensive sample configuration file sample-litd.conf for litd and links to it in the README.md. The feedback identifies two documentation errors in the new configuration file where the comments incorrectly state that the newly introduced options (remote.lit-logging.file.max-files and remote.lit-logging.file.max-file-size) are deprecated, rather than pointing out that the older legacy options are the ones being deprecated.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| ; Maximum number of log files to keep (0 for no rotation). Deprecated: use | ||
| ; remote.lit-logging.file.max-files instead. | ||
| ; remote.lit-logging.file.max-files=10 |
There was a problem hiding this comment.
The comment states that the option is deprecated and suggests using remote.lit-logging.file.max-files instead, but the option being documented on line 198 is actually remote.lit-logging.file.max-files itself. The deprecated option is actually remote.lit-maxlogfiles. This should be clarified to avoid confusion.
; Maximum number of log files to keep (0 for no rotation).
; The old option 'remote.lit-maxlogfiles' is deprecated.
; remote.lit-logging.file.max-files=10
| ; Maximum log file size in MB. Deprecated: use | ||
| ; remote.lit-logging.file.max-file-size instead. | ||
| ; remote.lit-logging.file.max-file-size=20 |
There was a problem hiding this comment.
The comment states that the option is deprecated and suggests using remote.lit-logging.file.max-file-size instead, but the option being documented on line 202 is actually remote.lit-logging.file.max-file-size itself. The deprecated option is actually remote.lit-maxlogfilesize. This should be clarified to avoid confusion.
; Maximum log file size in MB.
; The old option 'remote.lit-maxlogfilesize' is deprecated.
; remote.lit-logging.file.max-file-size=20
This commit modifies the comments in `sample-litd.conf` to clarify that the options 'remote.lit-maxlogfiles' and 'remote.lit-maxlogfilesize' are deprecated, encouraging users to use the new logging configuration parameters instead.
This commit modifies the README.md to change the comment style for section headers in `lit.conf` from `#` to `;`, and updates `sample-litd.conf` to specify a default value for `lndrpctimeout`, enhancing clarity on configuration options.
ViktorT-11
left a comment
ViktorT-11
left a comment
There was a problem hiding this comment.
Thanks for the contribution @victorabarros 🙏!
This could be a nice contribution. Since you're adding a sample_conf it would also be valuable if you additionally add a CI job that checks that it's been correctly updated with the new config options when such are added. lnd does have such a CI job, so I recommend looking into how it is implemented there and try to mimic that:
https://github.com/lightningnetwork/lnd/blob/1a6ecebcbf490de5e8932c782b0d57c5d57c5679/.github/workflows/main.yml#L67
Sure. Right now I'm AFK, but I can do that by EOD. |
This commit introduces a new target in the Makefile, `sample-conf-check`, which validates the options in `sample-litd.conf` against the help output of the `litd` command. Additionally, it adds a corresponding job in the GitHub Actions workflow to automate this check, ensuring that configuration options remain valid and up-to-date.
|
@ViktorT-11 |
ViktorT-11
left a comment
ViktorT-11
left a comment
There was a problem hiding this comment.
Thanks for the updates @victorabarros!
I've tested your changes, and the added make sample-conf-check currently correctly identifies if an option/flag in the sample-litd.conf file exists which isn't an actual config option/flag, so that's great!
However, the script currently doesn't correctly identify if litd has a config option/flag which doesn't have an entry in the sample-litd.conf file. This differs from the version in lnd which would identify that missing entry. You can test this easily by removing a config option/flag from the sample-litd.conf file , and then running the make sample-conf-check command.
Please update that so litd also has that check. I'll have another look once that's been updated 🔥
|
@victorabarros, remember to re-request review from reviewers when ready |
3 participants
What
Issue #1098
Introduces
sample-litd.conf— a comprehensive, well-commented configuration template forlitd— and updates the README to point users to it.Why
There was no single reference file for
litd-native configuration options. Users had to dig through--helpoutput or source code to understand what settings exist, what they do, and what the defaults are. This fills that gap.Changes
sample-litd.conf(new): 372-line annotated config covering application settings, TLS, Let's Encrypt, daemon modes, and more. Follows the same convention assample-lnd.confandsample-tapd.confin the broader Lightning ecosystem.README.md: Adds a note directing users tosample-litd.confas the canonical reference for litd-native config options, including descriptions and defaults.