Skip to content

chore(docs): clarify root credentials behavior and lifecycle#2312

Merged
spetz merged 4 commits intoapache:masterfrom
YangSiJun528:docs/clarify-root-credentials-behavior
Nov 5, 2025
Merged

chore(docs): clarify root credentials behavior and lifecycle#2312
spetz merged 4 commits intoapache:masterfrom
YangSiJun528:docs/clarify-root-credentials-behavior

Conversation

@YangSiJun528
Copy link
Contributor

Clarify that root credentials are only set on first server startup when the data directory doesn't exist.
Align documentation and log messages with actual implementation behavior.

Changes

  • README: Explain local_data directory and credential reuse
  • CLI help: Remove wrong "warning will be printed" text (warning only shows when env vars IGGY_ROOT_USERNAME/IGGY_ROOT_PASSWORD already exist)
  • Log message: Add note about credential reuse when using --with-default-root-credentials flag

Test Plan

  • Run server with --with-default-root-credentials, check log message
  • Run cargo run --bin iggy-server -- --help, verify updated text

@spetz spetz merged commit 995551c into apache:master Nov 5, 2025
91 of 94 checks passed
@YangSiJun528 YangSiJun528 deleted the docs/clarify-root-credentials-behavior branch November 5, 2025 08:46
hageshiame pushed a commit to hageshiame/iggy that referenced this pull request Nov 7, 2025
…2312)

Clarify that root credentials are only set on first server startup when the data directory doesn't exist.
Align documentation and log messages with actual implementation behavior.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants