Add Nitro configuration system guide#3321
Open
anegg0 wants to merge 1 commit into
Open
Conversation
Covers config sources and precedence, JSON config file format, environment variable mapping rules, Docker mounting, conf.dump, hot reload, and S3 config loading. All technical details verified against Nitro source code (cmd/nitro/config, genericconf, confighelpers).
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
anegg0
added a commit
that referenced
this pull request
May 27, 2026
The configuration-system guide has been split into its own stacked PR (#3321 — branch nitro-cli/configuration-system, base nitro-cli-guide) for focused SME review by @Jason-W123. Removing the file here so PR #3174 no longer duplicates that content; PR #3321 will re-add it when it merges back into nitro-cli-guide. Cross-references to /run-arbitrum-node/nitro/configuration-system from cli-flags-reference.mdx, sidebars.js, and scripts/generate-cli-reference.ts will be temporarily broken on this branch until #3321 merges. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
anegg0
added a commit
that referenced
this pull request
May 27, 2026
…3178 This page is reviewed in the standalone stacked PR #3178 (branch nitro-cli/node-tuning, base nitro-cli-guide) by @Jason-W123 and @a-thomas-22. Removing it here so PR #3174 no longer duplicates the content; PR #3178 re-adds it when it merges back into nitro-cli-guide. Cross-references to /run-arbitrum-node/nitro/node-tuning-and-monitoring from cli-flags-reference.mdx and scripts/generate-cli-reference.ts will be temporarily broken on this branch until #3178 merges. Same pattern as #3321 for configuration-system. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
anegg0
added a commit
that referenced
this pull request
May 27, 2026
The Docker images and CLI binaries reference is being split into its own stacked PR (branch nitro-cli/docker-and-cli-binaries, base nitro-cli-guide) for focused SME review by @a-thomas-22. Removing the file here so PR #3174 no longer carries it; the stacked PR re-adds it when it merges back into nitro-cli-guide. Cross-references from cli-flags-reference.mdx and the generator script will be temporarily broken on this branch until the stacked PR merges. Same pattern as #3321 (configuration-system) and #3322 (node-tuning). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Adds a how-to page covering Nitro's configuration system at
docs/run-arbitrum-node/nitro/configuration-system.mdx.Topics covered:
--conf.s3.*) → config files (--conf.file) → config string (--conf.string) → CLI flags → environment variables.--conf.env-prefixsemantics, the strip → lowercase →__→-→_→.transformation rules, and the full table of comma-split fields.-vmapping pattern + non-rootuserhome directory.--conf.dump— what gets emitted, which sensitive fields are scrubbed, and how to redirect to disk.--conf.reload-interval, thereload:"hot"tag in the Go source, and the list of top-level groups that support runtime reload.--conf.s3.access-key,--conf.s3.secret-key,--conf.s3.region,--conf.s3.bucket,--conf.s3.object-key, plus a worked example combining S3 with a local override file.All technical details verified against the Nitro source (
cmd/nitro/config,cmd/genericconf,cmd/util/confighelpers).Document type
Checklist
yarn startoryarn buildAdditional Notes
Split out from PR #3174 (Nitro CLI documentation guide) for focused SME review. Targets
nitro-cli-guideto stack on top of the parent PR; will merge into master through it.This PR will break the build, it's expected as it's a stacked PR. PR #3174 references
/run-arbitrum-node/nitro/configuration-systemfromcli-flags-reference.mdx,sidebars.js, and the generator script. Those links resolve cleanly only once this PR merges back intonitro-cli-guide.Linear: TW-693 (Nitro CLI reference — config system portion).