Document Signer's Configs #1644
Merged
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
wileyj
reviewed
Sep 26, 2024
wileyj
reviewed
Sep 26, 2024
wileyj
reviewed
Sep 26, 2024
wileyj
reviewed
Sep 26, 2024
|
some minor changes, but overall seems good. thanks @Jiloc |
Jiloc
force-pushed
the
feat/document-signer-configs
branch
from
eb53a78
to
1db7b39
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.
While following the documentation to set up the Signer, I noticed the absence of details regarding the configuration options, particularly for setting up Prometheus metrics. Specifically, the
metrics_endpoint, which was added in this commit, was not documented, nor were any of the other parameters.To address this, I have documented all the available signer configuration options, ensuring they align with the syntax used in the Stacks node configuration documentation (reference here). This includes an explanation of each parameter and a configuration example to facilitate user understanding and implementation.